Virima API Specification - DiscoveryClientService Services

The requests documented in this section are directed to DiscoveryClientService resources, which represent User addClient, archiveDiscoveryClient, editDiscoveryClients, updateClientState, updateClientCurrentStatus, discoveryScanCompleted, getAProbe, getSensorByProbe, getClientBySessionId, getAllCredentials, updateStatusOfDiscoveryScan, updateDiscoveryScanLog, getAllDiscoveryClient-- as called by a partner or directly by a webapp using the API..

Contents

1 addClient POST Interface
2 updateAgentKeyInRedis POST Interface
3 fetchAllAgentsOfParticularApp POST Interface
4 updateApplicationStatus POST Interface
5 archiveDiscoveryClient GET Interface
6 editDiscoveryClients POST Interface
7 editNameDiscoveryClient POST Interface
8 updateClientState POST Interface
9 updateClientCurrentStatus POST Interface
10 discoveryScanCompleted POST Interface
11 getAProbe POST Interface
12 getAProbeByName POST Interface
13 getSensorByProbe POST Interface
14 getClientBySessionId POST Interface
15 getClientStateBySessionId POST Interface
16 emailToLoggedinUserOnAppUpdate POST Interface
17 getAllCredentials POST Interface
18 updateStatusOfDiscoveryScan POST Interface
19 updateDiscoveryScanLog POST Interface
20 getAllDiscoveryClient GET Interface
21 getGroupProbeIdByName POST Interface
22 triggerScanForHost POST Interface
23 installOrUpdateAgent POST Interface
24 addScheduleScan POST Interface
25 schduleBulkScanForDiscoveryAgent POST Interface
26 editSingleDisocveryAgentScan POST Interface
27 deleteScheduledCronExpression POST Interface
28 deleteAgentCronExpression POST Interface
29 getAllScheduledCronExprssionsForDiscoveryAgents POST Interface
30 disassociateAgentsOfCron POST Interface
31 associateAgentsOfCron POST Interface
32 getAgentsToAssociate POST Interface
33 installDiscoveryAgent POST Interface
34 getAllAgentDetails POST Interface
35 getCredentialConfiguration POST Interface
36 getPaexecConfiguration POST Interface
37 addAgentSelfScanOutput POST Interface
38 getLatestScheduledCronTimingsForAgent POST Interface
39 sendDeleteAgentAcknowledgementFromAgent POST Interface
40 sendAddedCronAcknowledgementFromAgent POST Interface
41 deleteDiscoveryAgents POST Interface
42 deleteAgentDetailsFromDb POST Interface
43 getDiscoveryAppUpdateVersions POST Interface
44 hotfixApplyAcknowledgement POST Interface
45 checkForHotfixUpdate POST Interface
46 addADUsersToEM POST Interface
47 addLDAPUsersToEM POST Interface
48 markAdImportAsFinished POST Interface
49 markLDAPImportAsFinished POST Interface
50 getClientInformation POST Interface
51 updateClientSessionOnChange POST Interface
52 restartApplication POST Interface
53 addAgentAlarmConf POST Interface
54 getAgentSchedules GET Interface
55 getCronById GET Interface
56 getAllagentsBycronid GET Interface
57 addAgentCronExpression POST Interface
58 getAgentAlarmConf POST Interface
59 createIncidentFromAgentAlarmConf POST Interface
60 getCredentialEncryptionKey POST Interface
61 getAllCyberarkCredentials POST Interface
62 buildAgent POST Interface
63 pushAgentUpdatesOnClientUp POST Interface
64 getAgentUpdates POST Interface
65 latestAgentUpdatePushed POST Interface
66 getBuildAgentDownloadLink POST Interface

addClient POST Interface

addClient(POST) is called when user is trying to add new client.

It create a new client as per the post request

Method: POST

Relative URL: discovery-client/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Response Structure:

Field Name	Type	Description
response	RecordID

Example Request:

ADDCLIENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":351091159,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

Example Response:

{
   "id":333504066,
   "recordId":"?"
}

updateAgentKeyInRedis POST Interface

updateApplicationStatus(POST) is called when session file is deleted from application and application is stopped,the status of that application in db needs to be changed.

It usually happens when user changes the user password from EM

Method: POST

Relative URL: discovery-client/update-agent-key-in-redis

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATEAGENTKEYINREDIS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1000082883,
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2088829703,
   "response":"?"
}

fetchAllAgentsOfParticularApp POST Interface

fetchAllAgentsOfParticularApp(POST) is called when application disconnects from its agents due to an ipaddress change and wants to connect back to all those agents.

Method: POST

Relative URL: discovery-client/fetch-all-agents-of-particular-app

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

FETCHALLAGENTSOFPARTICULARAPP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

updateApplicationStatus POST Interface

updateApplicationStatus(POST) is called when session file is deleted from application and application is stopped,the status of that application in db needs to be changed.

It usually happens when user changes the user password from EM

Method: POST

Relative URL: discovery-client/update-application-status

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
response	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATEAPPLICATIONSTATUS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":1706561855,
   "response":"?"
}

archiveDiscoveryClient GET Interface

archiveDiscoveryClient(POST) is called when user wants to delete discovery client.

It checks for RecordId that the user wants to delete.
If Id is found, then the record get deleted else it throws an error.

Method: GET

Relative URL: discovery-client/archive/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editDiscoveryClients POST Interface

editDiscoveryClients(POST) is called when user is trying to add/edit a client.

If the id is -1 then it will add a new discovery client
else it will check for the discovery client based on thier id and edit
If id is not there in database then throws an error

Method: POST

Relative URL: discovery-client/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITDISCOVERYCLIENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editNameDiscoveryClient POST Interface

editNameDiscoveryClient(POST) is called when user is trying to add/edit a user given client name.

Check for the name already exist or not, if not then edit the name

Method: POST

Relative URL: discovery-client/edit-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITNAMEDISCOVERYCLIENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":1005170729,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

updateClientState POST Interface

updateClientState(POST) is called when user is trying to update the state of client.

It takes the client as per post request, and edit its status
For invalid id given, throws error

Method: POST

Relative URL: discovery-client/update-client-state

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	UpdateClinetByStateInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATECLIENTSTATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

updateClientCurrentStatus POST Interface

updateClientState(POST) is called when user is trying to update the state of client.

It takes the client as per their id, and edit their status
For invalid id given, throws error

Method: POST

Relative URL: discovery-client/update-client-current-status

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	UpdateClinetByCurrentStatusInput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATECLIENTCURRENTSTATUS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "currentStatus":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

discoveryScanCompleted POST Interface

discoveryScanCompleted(POST) is called when the discovery scan got completed.

From the input get the scan, and set isCompleted as per input
For invalid ids throws error

Method: POST

Relative URL: discovery-client/discovery-scan-completed

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DISCOVERYSCANCOMPLETED 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAProbe POST Interface

getAProbe(POST) is called when the application needs to get a probe Record.

Method: POST

Relative URL: discovery-client/get-probe

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
probe	Probe

Example Request:

GETAPROBE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "probeType":"?",
   "probeParameters":"?",
   "archive":?,
   "sensorId":?,
   "sensorName":"?",
   "uniqueId":"?"
}

getAProbeByName POST Interface

getAProbe(POST) is called when the application needs to get a probe Record by name.

Method: POST

Relative URL: discovery-client/get-probe-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
probe	Probe

Example Request:

GETAPROBEBYNAME 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "probeType":"?",
   "probeParameters":"?",
   "archive":?,
   "sensorId":?,
   "sensorName":"?",
   "uniqueId":"?"
}

getSensorByProbe POST Interface

getSensorByProbe(POST) is called when the application needs to get a sensor Record.

Method: POST

Relative URL: discovery-client/get-sensor-by-probe

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
sensor	Sensor

Example Request:

GETSENSORBYPROBE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "scriptText":"?",
   "archive":?,
   "uniqueId":"?"
}

getClientBySessionId POST Interface

getClientBySessionId(POST) is called when the application needs to get a client by its session id.

Method: POST

Relative URL: discovery-client/get-client-by-sessionid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Example Request:

GETCLIENTBYSESSIONID 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

getClientStateBySessionId POST Interface

getClientStateBySessionId(POST) is called when the application needs to get a client by its session id.

Method: POST

Relative URL: discovery-client/get-client-state-by-sessionid

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCLIENTSTATEBYSESSIONID 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

emailToLoggedinUserOnAppUpdate POST Interface

send Email to Apllication loggedin User(POST) is called when the application is Updated.

Method: POST

Relative URL: discovery-client/email-to-loggedin-user-on-app-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
mail	Mail

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EMAILTOLOGGEDINUSERONAPPUPDATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "subject":"?",
   "body":"?",
   "clientSessionId":"?",
   "customerId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllCredentials POST Interface

getAllCredentials(POST) is called when the application needs to get all the credentials stored for the particular customer.

Method: POST

Relative URL: discovery-client/get-all-credentials-of

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
arrayOfCredentials	ArrayOfCredential

Example Request:

GETALLCREDENTIALS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "encryptionKey":"?",
   "credential":[
      {
         "id":2147483647,
         "status":?,
         "name":"?",
         "credentialType":"?",
         "userName":"?",
         "password":"?",
         "sshPrivateKey":"?",
         "passphrase":"?",
         "isWorkgroup":?,
         "domainName":"?",
         "workgroupName":"?",
         "priority":?,
         "ipRange":"?",
         "archive":?,
         "isLocal":?,
         "uniqueId":"?",
         "dcName":"?",
         "dcIp":"?",
         "tenantId":"?",
         "clientId":"?",
         "secretKey":"?",
         "subscriptionId":"?",
         "lastModifiedOn":?,
         "isSqlserverWindowsAuthentication":?,
         "port":"?",
         "instanceName":"?",
         "isLinuxOS":?,
         "active":?,
         "isSubscriptionID":?,
         "isManagementGroupID":?,
         "awsCredentialType":"?",
         "siteCode":"?",
         "azureAuthType":"?",
         "azureCertificate":"?",
         "azurePrivateKey":"?"
      }   ]
}

updateStatusOfDiscoveryScan POST Interface

updateStatusOfDiscoveryScan(POST) is called when user is trying to update the status of the scan.

It takes the scan record as per post request, and edit its status
For invalid id given, throws error

Method: POST

Relative URL: discovery-client/update-discovery-scan-status

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATESTATUSOFDISCOVERYSCAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

updateDiscoveryScanLog POST Interface

updateDiscoveryScanLog(POST) is called when user is trying to update the log of the scan.

It takes the scan record as per post request, and edit its log
For invalid id given, throws error

Method: POST

Relative URL: discovery-client/update-scan-log

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

UPDATEDISCOVERYSCANLOG 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllDiscoveryClient GET Interface

getAllDiscoveryClient(GET) is called when the application needs to get all the discovery client records.

Method: GET

Relative URL: discovery-client/get-all

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
arrayOfDiscoveryClient	ArrayOfDiscoveryClient

Example Request:

Example Response:

{
   "id":2147483647,
   "client":[
      {
         "id":2147483647,
         "clientSessionId":"?",
         "state":?,
         "addedOn":?,
         "currentStateTime":?,
         "hostName":"?",
         "name":"?",
         "clientName":"?",
         "ipAddress":"?",
         "subnet":"?",
         "currentStatus":"?",
         "archive":?,
         "customerId":?,
         "uniqueId":"?",
         "location": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "userId":"?",
         "operatingSystem":"?",
         "serverIpAddress":"?",
         "serverDNSName":"?",
         "noOfAssetsDiscovered":?,
         "version":"?",
         "proxy":?,
         "agentScanEnabled":?,
         "agentAutoUpdateThroughAppEnabled":?,
         "autoUpdateApp":?,
         "lastStatusUpdate":?,
         "latestVersionFoClient":"?",
         "fqdn":"?",
         "liveConnectionServerSSL":?,
         "liveConnectionServerPort":"?",
         "webservicesPort":"?",
         "certificate":"?",
         "serialNumber":"?"
      }   ]
}

getGroupProbeIdByName POST Interface

Method: POST

Relative URL: discovery-client/get-group-probe-id-by-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETGROUPPROBEIDBYNAME 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

triggerScanForHost POST Interface

Method: POST

Relative URL: discovery-client/trigger-scan-for-host

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
scanInput	DiscoveryScan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

TRIGGERSCANFORHOST 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "scanId":"?",
   "totalTime":?,
   "status":"?",
   "scanLogs":"?",
   "parameters":"?",
   "archive":?,
   "isCompleted":?,
   "isAborted":?,
   "probeId":?,
   "probeType":"?",
   "groupProbeId":?,
   "clientId":?,
   "credentialId":?,
   "probeName":"?",
   "clientName":"?",
   "clientSessionId":"?",
   "uniqueId":"?",
   "roles":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "users":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "groups":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "departments":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "ipTocredentialIdMap":"?",
   "runBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "startTime":?,
   "endTime":?,
   "triggeredFromScheduledScan":?,
   "excludeIP":"?",
   "ports":"?",
   "daIpAddress":"?",
   "certificatePath":"?",
   "registryPath":"?",
   "softwareUrl":"?",
   "installArguments":"?",
   "auditId":?,
   "isFromIPAM":?,
   "blueprintMSSQL":"?",
   "isCreateDiscAsset":?,
   "isExportData":?,
   "isDiscAssetAvailable":?,
   "isExportDataDone":?,
   "mssqlDataMappingParameters":"?",
   "mssqlQuery":"?",
   "isQuickScan":?,
   "isHostNamesScan":?,
   "hostNames":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

installOrUpdateAgent POST Interface

Method: POST

Relative URL: discovery-client/install-agent/is-auto-push/is-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
scanInput	DiscoveryScan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

INSTALLORUPDATEAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "scanId":"?",
   "totalTime":?,
   "status":"?",
   "scanLogs":"?",
   "parameters":"?",
   "archive":?,
   "isCompleted":?,
   "isAborted":?,
   "probeId":?,
   "probeType":"?",
   "groupProbeId":?,
   "clientId":?,
   "credentialId":?,
   "probeName":"?",
   "clientName":"?",
   "clientSessionId":"?",
   "uniqueId":"?",
   "roles":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "users":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "groups":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "departments":[
      {
         "id":1307069554,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "ipTocredentialIdMap":"?",
   "runBy": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "location": {
         "id":1857111975,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "startTime":?,
   "endTime":?,
   "triggeredFromScheduledScan":?,
   "excludeIP":"?",
   "ports":"?",
   "daIpAddress":"?",
   "certificatePath":"?",
   "registryPath":"?",
   "softwareUrl":"?",
   "installArguments":"?",
   "auditId":?,
   "isFromIPAM":?,
   "blueprintMSSQL":"?",
   "isCreateDiscAsset":?,
   "isExportData":?,
   "isDiscAssetAvailable":?,
   "isExportDataDone":?,
   "mssqlDataMappingParameters":"?",
   "mssqlQuery":"?",
   "isQuickScan":?,
   "isHostNamesScan":?,
   "hostNames":"?"
}

Example Response:

{
   "id":1424351740,
   "response":"?"
}

addScheduleScan POST Interface

Method: POST

Relative URL: discovery-client/add-schedule-scan

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDSCHEDULESCAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":2147483647,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

schduleBulkScanForDiscoveryAgent POST Interface

Method: POST

Relative URL: discovery-client/schedule-bulk-scan/is-bulk-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SCHDULEBULKSCANFORDISCOVERYAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":400890501,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":1113747709,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editSingleDisocveryAgentScan POST Interface

Method: POST

Relative URL: discovery-client/edit-single-agent-scan/is-bulk-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITSINGLEDISOCVERYAGENTSCAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":2147483647,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteScheduledCronExpression POST Interface

Method: POST

Relative URL: discovery-client/delete-cron-expression/is-bulk-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETESCHEDULEDCRONEXPRESSION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":371792383,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":1319790700,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":1306292565,
   "response":"?"
}

deleteAgentCronExpression POST Interface

Method: POST

Relative URL: discovery-client/delete-agent-cron-expression/is-bulk-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEAGENTCRONEXPRESSION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":2147483647,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllScheduledCronExprssionsForDiscoveryAgents POST Interface

Method: POST

Relative URL: discovery-client/get-all-cron-expressions-for-agents/id/client-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLSCHEDULEDCRONEXPRSSIONSFORDISCOVERYAGENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":983707578,
   "response":"?"
}

disassociateAgentsOfCron POST Interface

Method: POST

Relative URL: discovery-client/disassociate-agents-of-cron/is-bulk-schedule

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DISASSOCIATEAGENTSOFCRON 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2118788660,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":2147483647,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

associateAgentsOfCron POST Interface

Method: POST

Relative URL: discovery-client/associate-agents-of-cron

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ASSOCIATEAGENTSOFCRON 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":162767933,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAgentsToAssociate POST Interface

Method: POST

Relative URL: discovery-client/get-agents-to-associate/page-number/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
stringInput	StringInputforDiscoveryAgent

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETAGENTSTOASSOCIATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientId":"?",
   "searchkey":"?",
   "ignoreIds":"?",
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

installDiscoveryAgent POST Interface

Method: POST

Relative URL: discovery-client/install-discovery-agent/is-auto-push/is-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
scanInput	DiscoveryAgentInstall

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

INSTALLDISCOVERYAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "daIpAddress":"?",
   "targetIPAddresses":"?",
   "cronExpressions":"?",
   "clientId":?,
   "isHostNamesScan":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllAgentDetails POST Interface

Method: POST

Relative URL: discovery-client/get-all-agents

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLAGENTDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCredentialConfiguration POST Interface

Method: POST

Relative URL: discovery-client/get-credential-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCREDENTIALCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getPaexecConfiguration POST Interface

Method: POST

Relative URL: discovery-client/get-paexec-configuration

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETPAEXECCONFIGURATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addAgentSelfScanOutput POST Interface

Adds the discovery agent self scan data into async db after processing (correlation etc)

Method: POST

Relative URL: discovery-client/add-agent-self-scan-output

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentSelfScanOutput	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

ADDAGENTSELFSCANOUTPUT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

getLatestScheduledCronTimingsForAgent POST Interface

Get latest scheduled cron timings from EM for specified agent by agent id

Method: POST

Relative URL: discovery-client/get-latest-scheduled-cron-timings-for-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

GETLATESTSCHEDULEDCRONTIMINGSFORAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

sendDeleteAgentAcknowledgementFromAgent POST Interface

Agent deleted acknowledgement from Discovery Application, so entry should be deleted from database as well

Method: POST

Relative URL: discovery-client/send-delete-agent-acknowledgement-from-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

SENDDELETEAGENTACKNOWLEDGEMENTFROMAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

sendAddedCronAcknowledgementFromAgent POST Interface

Send acknowledgement request from agent, which tells which and all cron got reflected in agent.

Method: POST

Relative URL: discovery-client/send-added-cron-acknowledgement-from-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

SENDADDEDCRONACKNOWLEDGEMENTFROMAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

deleteDiscoveryAgents POST Interface

Method: POST

Relative URL: discovery-client/delete-discovery-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEDISCOVERYAGENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1487185651,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":2147483647,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteAgentDetailsFromDb POST Interface

Method: POST

Relative URL: discovery-client/delete-agent-details-from-db

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentDetails	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEAGENTDETAILSFROMDB 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getDiscoveryAppUpdateVersions POST Interface

Method: POST

Relative URL: discovery-client/get-discovery-app-update-versions

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETDISCOVERYAPPUPDATEVERSIONS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

hotfixApplyAcknowledgement POST Interface

Update discoveryWindowsUpdatesQueue table entry as per acknowledgement received from application

Method: POST

Relative URL: discovery-client/hotfix-apply-acknowledgement

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

HOTFIXAPPLYACKNOWLEDGEMENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

checkForHotfixUpdate POST Interface

Check for queued hotfix update for windows machine. This request will only be coming from Discovery Server

Method: POST

Relative URL: discovery-client/check-for-hotfix-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

CHECKFORHOTFIXUPDATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

addADUsersToEM POST Interface

Add AD Users

Method: POST

Relative URL: discovery-client/add-ad-users-to-em

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

ADDADUSERSTOEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

addLDAPUsersToEM POST Interface

Add LDAP Users

Method: POST

Relative URL: discovery-client/add-ldap-users-to-em

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

ADDLDAPUSERSTOEM 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":117853933,
   "recordId":"?",
   "message":"?",
   "status":?
}

markAdImportAsFinished POST Interface

Marking AD import (via Discovery Application) as finished

Method: POST

Relative URL: discovery-client/mark-ad-import-as-finished

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

MARKADIMPORTASFINISHED 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

markLDAPImportAsFinished POST Interface

Marking LDAP import (via Discovery Application) as finished

Method: POST

Relative URL: discovery-client/mark-ldap-import-as-finished

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

MARKLDAPIMPORTASFINISHED 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

getClientInformation POST Interface

getClientInformation is called for getting client information from client session id.

Method: POST

Relative URL: discovery-client/get-client-info

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

GETCLIENTINFORMATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

updateClientSessionOnChange POST Interface

updateClientSessionOnChange is called to update client session on client update

Method: POST

Relative URL: discovery-client/update-client-session-on-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	UpdateClientSessionAgent

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

UPDATECLIENTSESSIONONCHANGE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":466621375,
   "clientSessionId":"?",
   "requestId":"?",
   "agentId":"?",
   "accessToken":"?",
   "ipAddress":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

restartApplication POST Interface

restartApplication(POST) is called when user wants to restart client from EM.

It simply restarts the client

Method: POST

Relative URL: discovery-client/restart-application

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClient	DiscoveryClient

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

RESTARTAPPLICATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "state":?,
   "addedOn":?,
   "currentStateTime":?,
   "hostName":"?",
   "name":"?",
   "clientName":"?",
   "ipAddress":"?",
   "subnet":"?",
   "currentStatus":"?",
   "archive":?,
   "customerId":?,
   "uniqueId":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "userId":"?",
   "operatingSystem":"?",
   "serverIpAddress":"?",
   "serverDNSName":"?",
   "noOfAssetsDiscovered":?,
   "version":"?",
   "proxy":?,
   "agentScanEnabled":?,
   "agentAutoUpdateThroughAppEnabled":?,
   "autoUpdateApp":?,
   "lastStatusUpdate":?,
   "latestVersionFoClient":"?",
   "fqdn":"?",
   "liveConnectionServerSSL":?,
   "liveConnectionServerPort":"?",
   "webservicesPort":"?",
   "certificate":"?",
   "serialNumber":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

addAgentAlarmConf POST Interface

add-agent-alarm-conf to Add, Update, Delete Agent Alarm Configuration

Method: POST

Relative URL: discovery-client/add-agent-alarm-conf

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentAlarmConf	AgentAlarmConf

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDAGENTALARMCONF 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "condition":"?",
   "percentage":"?",
   "agentId":"?",
   "isActive":?,
   "archive":?,
   "clientSessionId":"?",
   "accessToken":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAgentSchedules GET Interface

Method: GET

Relative URL: discovery-client/get-agent-schedules/client-id/page-no/limit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCronById GET Interface

Method: GET

Relative URL: discovery-client/get-cron-by-id/cron-id/client-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllagentsBycronid GET Interface

Method: GET

Relative URL: discovery-client/get-allagents-by-cronid/cron-id/client-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addAgentCronExpression POST Interface

Method: POST

Relative URL: discovery-client/add-agent-cron-expression

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
cronExpression	CronExpressionPojo

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDAGENTCRONEXPRESSION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "cronExpression":"?",
   "agentIdList":[
      {
         "id":2147483647,
         "flag":?
      }   ],
   "clientId":"?",
   "clientSessionId":"?",
   "isBulk":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAgentAlarmConf POST Interface

get Agent Alarm Configuration

Method: POST

Relative URL: discovery-client/get-agent-alarm-conf

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentAlarmConf	AgentAlarmConf

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETAGENTALARMCONF 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "condition":"?",
   "percentage":"?",
   "agentId":"?",
   "isActive":?,
   "archive":?,
   "clientSessionId":"?",
   "accessToken":"?"
}

Example Response:

{
   "id":641719993,
   "response":"?"
}

createIncidentFromAgentAlarmConf POST Interface

Create Incident For Agent Alarm Configuration

Method: POST

Relative URL: discovery-client/create-incident-from-agent-alarm-conf

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentAlarmConf	AgentAlarmConf

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

CREATEINCIDENTFROMAGENTALARMCONF 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "condition":"?",
   "percentage":"?",
   "agentId":"?",
   "isActive":?,
   "archive":?,
   "clientSessionId":"?",
   "accessToken":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCredentialEncryptionKey POST Interface

getSensorByProbe(POST) is called when the application needs to get a sensor Record.

Method: POST

Relative URL: discovery-client/get-credential-encryption-key

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
input	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETCREDENTIALENCRYPTIONKEY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllCyberarkCredentials POST Interface

getAllCredentials(POST) is called when the application needs to get all the credentials stored for the particular customer.

Method: POST

Relative URL: discovery-client/get-all-cyberark-credentials

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETALLCYBERARKCREDENTIALS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

buildAgent POST Interface

Discovery Build Agent is called when customer needs to build Agent.

Method: POST

Relative URL: discovery-client/build-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoverybuildagent	DiscoveryBuildAgent

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

BUILDAGENT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":335953440,
   "daIPAddress":"?",
   "liveConnectionServerPort":"?",
   "daServicePort":"?",
   "ProxyHost":"?",
   "ProxyPort":"?",
   "proxyuserName":"?",
   "proxyPassword":"?",
   "liveConnectionServerIp":"?",
   "fileName":"?",
   "folderPath":"?",
   "clientSessionId":"?",
   "clientName":"?",
   "machineType":"?",
   "linuxType":"?",
   "bits":"?",
   "myIpaddress":"?",
   "serialNumber":"?",
   "certificate":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

pushAgentUpdatesOnClientUp POST Interface

This method is called to push the Agent Updates from Discovery Server to Discovery Application

Method: POST

Relative URL: discovery-client/push-agent-updates-on-client-up

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

PUSHAGENTUPDATESONCLIENTUP 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAgentUpdates POST Interface

Get agent updates urls

Method: POST

Relative URL: discovery-client/get-agent-updates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryAgent	AgentSelfScanOutput

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

GETAGENTUPDATES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "agentId":"?",
   "output":"?",
   "ipAddress":"?",
   "description":"?",
   "isActive":"?",
   "reflectAccountStatus":"?",
   "mailPermission":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

latestAgentUpdatePushed POST Interface

Method: POST

Relative URL: discovery-client/latest-agent-update-pushed

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryInputGeneric	DiscoveryInputGeneric

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

LATESTAGENTUPDATEPUSHED 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?",
   "entity_id":"?",
   "value":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getBuildAgentDownloadLink POST Interface

Method: POST

Relative URL: discovery-client/get-buildagent-download-link/machine-type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
clientSessionId	ClientSessionIdentifier

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

GETBUILDAGENTDOWNLOADLINK 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "clientSessionId":"?"
}

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}