Virima API Specification - DiscoveryScanService Services

The requests documented in this section are directed to DiscoveryScanService 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 abortDiscoveryScan POST Interface
3 getDiscoveryScanRec POST Interface
4 editDiscoveryScheduleScan POST Interface
5 processIPConnection POST Interface
6 addScanReport POST Interface
7 addScanReportForHost POST Interface
8 getScanReport GET Interface
9 getScanHostReport GET Interface
10 getSubnetForAgent 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: discoveryscan1/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":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":"?"
}

abortDiscoveryScan POST Interface

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

Method: POST

Relative URL: discoveryscan1/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":1553835760,
   "flag":?
}

Example Response:

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

getDiscoveryScanRec POST Interface

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

Method: POST

Relative URL: discoveryscan1/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:

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

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: discoveryscan1/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":1982362414,
         "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: discoveryscan1/process-ip-connections

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:

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

Example Response:

{
   "id":18805213,
   "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: discoveryscan1/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":2147483647,
   "scanId":"?",
   "totalHost":?,
   "hostDetails":"?"
}

Example Response:

{
   "id":1677986111,
   "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: discoveryscan1/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":"?"
}

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: discoveryscan1/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: discoveryscan1/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":2147483647,
   "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: discoveryscan1/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":1200104578,
   "response":"?"
}