Virima API Specification - DiscoveryScanSplitService Services

The requests documented in this section are directed to DiscoveryScanSplitService resources, which represent User addDiscoveryScan, archiveDiscoveryScan, editDiscoveryScan, abortDiscoveryScan, getDiscoveryScanRec, editDiscoveryScheduleScan, processIPConnection-- as called by a partner or directly by a webapp using the API..

Contents

1 editDiscoveryScan POST Interface
2 rescanFromBSMView POST Interface
3 bulkScheduleUpdate POST Interface
4 abortDiscoveryScan POST Interface
5 getDiscoveryScanDetails POST Interface
6 editDiscoveryScheduleScan POST Interface
7 processIPConnection POST Interface
8 addScanReport POST Interface
9 addScanReportForHost POST Interface
10 addPortScanReportForHost POST Interface
11 getScanReport GET Interface
12 getScanHostReport GET Interface
13 getSubnetForAgent GET Interface
14 getScanLogs GET Interface
15 downloadScanHostReport GET Interface
16 checkForClientUpdates POST Interface
17 updateClients POST Interface
18 updateAgents POST Interface
19 getClientLatestVersion GET Interface
20 getAgentLatestVersion GET Interface
21 getRegistryInfo POST Interface
22 reScanWithScanId POST Interface
23 importScheduleScan POST Interface
24 getBuildAgentCheckForInstallAgent GET Interface

editDiscoveryScan POST Interface

editDiscoveryScan(POST) is called when user is trying to add/edit a discovery scan.

If the id is -1 then, it create a new discovery scan
else if id is there, then the record get edited else it throws an error.

Method: POST

Relative URL: discoveryscan/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryScan	DiscoveryScan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITDISCOVERYSCAN 
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":1004427247,
         "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":20065409,
         "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":"?"
}

rescanFromBSMView POST Interface

Method: POST

Relative URL: discoveryscan/re-scan-from-bsm

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryScan	DiscoveryScan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

RESCANFROMBSMVIEW 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1819705819,
   "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":312864747,
   "response":"?"
}

bulkScheduleUpdate POST Interface

Method: POST

Relative URL: discoveryscan/bulk-schedule-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryScheduleScan	DiscoveryScheduleScan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

BULKSCHEDULEUPDATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "parameters":"?",
   "archive":?,
   "probeId":?,
   "probeType":"?",
   "groupProbeId":?,
   "clientId":?,
   "probeName":"?",
   "clientName":"?",
   "uniqueId":"?",
   "timeZone":"?",
   "roles":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "users":[
      {
         "id":279951800,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "groups":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "departments":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "scanFrequency":"?",
   "isScheduled":?,
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "recurring":?,
   "isRecurringChecked":?,
   "isActiveChecked":?,
   "ports":"?",
   "certificatePath":"?",
   "registryPath":"?",
   "softwareUrl":"?",
   "installArguments":"?",
   "isActive":?,
   "auditId":?,
   "previousTriggerTime":?,
   "nextTriggerTime":?,
   "cronExpressionInReadableFormat":"?",
   "isFromIPAM":?,
   "blueprintMSSQL":"?",
   "isCreateDiscAsset":?,
   "isExportData":?,
   "mssqlDataMappingParameters":"?",
   "mssqlQuery":"?",
   "isHostNamesScan":?,
   "excludeIP":"?"
}

Example Response:

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

abortDiscoveryScan POST Interface

abortDiscoveryScan(POST) is called when user is trying to abort a discovery scan.

Method: POST

Relative URL: discoveryscan/abort

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
id	ID

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ABORTDISCOVERYSCAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":156229391,
   "flag":?
}

Example Response:

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

getDiscoveryScanDetails POST Interface

getDiscoveryScanRec(GET) is called when the application needs to get a discovery scan Record.

Method: POST

Relative URL: discoveryscan/get-disc-scan

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
id	ID

Response Structure:

Field Name	Type	Description
discScan	DiscoveryScan

Example Request:

GETDISCOVERYSCANDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "flag":?
}

Example Response:

{
   "id":2147483647,
   "name":"?",
   "scanId":"?",
   "totalTime":?,
   "status":"?",
   "scanLogs":"?",
   "parameters":"?",
   "archive":?,
   "isCompleted":?,
   "isAborted":?,
   "probeId":?,
   "probeType":"?",
   "groupProbeId":?,
   "clientId":?,
   "credentialId":?,
   "probeName":"?",
   "clientName":"?",
   "clientSessionId":"?",
   "uniqueId":"?",
   "roles":[
      {
         "id":192058152,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "users":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "groups":[
      {
         "id":580344448,
         "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":"?"
}

editDiscoveryScheduleScan POST Interface

editDiscoveryScan(POST) is called when user is trying to add/edit a discovery scheduled scan.

If the id is -1 then, it create a new discovery scheduled scan
else if id is there, then the record get edited else it throws an error.

Method: POST

Relative URL: discoveryscan/editschedulescan

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryScheduleScan	DiscoveryScheduleScan

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITDISCOVERYSCHEDULESCAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "parameters":"?",
   "archive":?,
   "probeId":?,
   "probeType":"?",
   "groupProbeId":?,
   "clientId":?,
   "probeName":"?",
   "clientName":"?",
   "uniqueId":"?",
   "timeZone":"?",
   "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":"?",
      }   ],
   "scanFrequency":"?",
   "isScheduled":?,
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "location": {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "recurring":?,
   "isRecurringChecked":?,
   "isActiveChecked":?,
   "ports":"?",
   "certificatePath":"?",
   "registryPath":"?",
   "softwareUrl":"?",
   "installArguments":"?",
   "isActive":?,
   "auditId":?,
   "previousTriggerTime":?,
   "nextTriggerTime":?,
   "cronExpressionInReadableFormat":"?",
   "isFromIPAM":?,
   "blueprintMSSQL":"?",
   "isCreateDiscAsset":?,
   "isExportData":?,
   "mssqlDataMappingParameters":"?",
   "mssqlQuery":"?",
   "isHostNamesScan":?,
   "excludeIP":"?"
}

Example Response:

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

processIPConnection POST Interface

processIPConnection(POST) service for process ip connections

This method reads the IP connections from DB in a map and tries to get Pair of IP Connections such as:

e.g. while scanning IP1 we get following connection IP1:PORTX ---- IP2:PORTY

and while scanning IP2 we get following connection IP2:PORTY ---- IP1:PORTX

Once we get such relation, then we create IP connection relation between software instances by calling resolveIPConnections
Parameter since (timestamp). Get ip connections from since

Method: POST

Relative URL: discoveryscan/process-ip-connections

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

PROCESSIPCONNECTION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

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

addScanReport POST Interface

addScanReport(POST) service for adding scan report summary

This method will add detailed report for a scan

Method: POST

Relative URL: discoveryscan/add-scan-report

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
report	ScanReportSummary

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDSCANREPORT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1624220237,
   "scanId":"?",
   "totalHost":?,
   "hostDetails":"?"
}

Example Response:

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

addScanReportForHost POST Interface

addScanReportForHost(POST) service for adding scan report summary for each host

This method will add detailed report for a scanned host

Method: POST

Relative URL: discoveryscan/add-scan-report-for-host

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
report	ScanHostReport

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDSCANREPORTFORHOST 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":"?",
   "blueprint":"?",
   "blueprintIcon":"?",
   "recordId":"?",
   "discId":"?",
   "hostIP":"?",
   "result":"?",
   "hostName":"?",
   "reasonDescription":"?",
   "deviceSummary":"?",
   "createdAt":?,
   "beingScanned":?,
   "portScanReport":"?"
}

Example Response:

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

addPortScanReportForHost POST Interface

addPortScanReportForHost(POST) service for adding port scan report summary for each host

This method will add port scanned result for the scanned host

Method: POST

Relative URL: discoveryscan/add-port-scan-report-for-host

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
report	ScanHostReport

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDPORTSCANREPORTFORHOST 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":"?",
   "blueprint":"?",
   "blueprintIcon":"?",
   "recordId":"?",
   "discId":"?",
   "hostIP":"?",
   "result":"?",
   "hostName":"?",
   "reasonDescription":"?",
   "deviceSummary":"?",
   "createdAt":?,
   "beingScanned":?,
   "portScanReport":"?"
}

Example Response:

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

getScanReport GET Interface

getScanReport(POST) service for adding scan report summary for scan

This method will get detailed report for a scan

Method: GET

Relative URL: discoveryscan/get-scan-report/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ScanReportSummary

Example Request:

Example Response:

{
   "id":2147483647,
   "scanId":"?",
   "totalHost":?,
   "hostDetails":"?"
}

getScanHostReport GET Interface

getScanReport(POST) service for adding scan report summary for host

This method will get detailed report for a scanned host

Method: GET

Relative URL: discoveryscan/get-scan-host-report/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ScanHostReport

Example Request:

Example Response:

{
   "id":1597038310,
   "scanId":"?",
   "blueprint":"?",
   "blueprintIcon":"?",
   "recordId":"?",
   "discId":"?",
   "hostIP":"?",
   "result":"?",
   "hostName":"?",
   "reasonDescription":"?",
   "deviceSummary":"?",
   "createdAt":?,
   "beingScanned":?,
   "portScanReport":"?"
}

getSubnetForAgent GET Interface

getSubnetForAgent(POST) service for getting subnet from the agent

This method will get detailed report for a scanned host

Method: GET

Relative URL: discoveryscan/get-subnet-for-agent/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":"?"
}

getScanLogs GET Interface

Method: GET

Relative URL: discoveryscan/get-scan-logs/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":"?"
}

downloadScanHostReport GET Interface

Download scan host report

Method: GET

Relative URL: discoveryscan/download-scan-host-report/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

checkForClientUpdates POST Interface

checkForClientUpdates(POST) will give all the updates for the client.

Get all the update details from management db

Method: POST

Relative URL: discoveryscan/check-for-client-updates

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClients	IntegerList

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

CHECKFORCLIENTUPDATES 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "actionType":"?",
}

Example Response:

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

updateClients POST Interface

updateClients(POST) will update clients to the latest version.

Get all the update details from management db
Apply each latest updates to the clients

Method: POST

Relative URL: discoveryscan/update-clients

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClients	IntegerList

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

UPDATECLIENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "actionType":"?",
}

Example Response:

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

updateAgents POST Interface

updateAgents(POST) will update agents to the latest version.

Get all the update details from management db
Apply each latest updates to the agents

Method: POST

Relative URL: discoveryscan/update-agents/is-bulk

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryClients	IntegerList

Response Structure:

Field Name	Type	Description
response	TransactionMessage

Example Request:

UPDATEAGENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "actionType":"?",
}

Example Response:

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

getClientLatestVersion GET Interface

getClientLatestVersion(POST) will give latest available version of client.

Get latest version information of client from management db

Method: GET

Relative URL: discoveryscan/get-client-latest-version

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":"?"
}

getAgentLatestVersion GET Interface

getAgentLatestVersion(POST) will give latest available version of agent.

Get latest version information of agent from management db

Method: GET

Relative URL: discoveryscan/get-agent-latest-version/client-id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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

getRegistryInfo POST Interface

Method: POST

Relative URL: discoveryscan/get-registry-info

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

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

Example Response:

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

reScanWithScanId POST Interface

reScanWithScanId(POST) is called when user is trying to rescan an existing scan.

id of the scan which user is trying to rescan need to be passed. Service fetches the existing scan details from table and calls the editDiscoveryScan method with those details.

Method: POST

Relative URL: discoveryscan/rescan

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
discoveryScan	Response

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

RESCANWITHSCANID 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1469014099,
   "response":"?"
}

Example Response:

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

importScheduleScan POST Interface

Method: POST

Relative URL: discoveryscan/import-schedule-scan

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
details	ImportCIDetails

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

IMPORTSCHEDULESCAN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "fileId":?,
   "fileName":"?",
   "editValues":[
      {
         "property":"?",
         "value":"?",
         "blockId":"?"
      }   ]
}

Example Response:

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

getBuildAgentCheckForInstallAgent GET Interface

Method: GET

Relative URL: discoveryscan/get-buildagent-check-installagent/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

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