Virima API Specification - ProbeService Services

The requests documented in this section are directed to ProbeService resources, which represent User addRisk, archiveRisk, editRisk,getAllRiskRecords, getHistory, getRiskProperties,getRiskFilterRecord, getRiskCount, addRiskDashborad,getRiskDashborad, wildCardSearchRisk, getRecordsFromIdsRisk, exportRisk, exportRiskSearch-- as called by a partner or directly by a webapp using the API..

Contents

1 addProbe POST Interface
2 archiveProbe POST Interface
3 editProbe POST Interface

addProbe POST Interface

addProbeService(POST) is called when user is trying to add risk using user credential.

ProbeTypes are SSH_Probe, SNMP_Probe, Windows_Probe, Script_Probe Checks for mandatory fields(name,owner,project,risk type,status,probability,impact)
The risk score is calculated if all the mandatory fields are filled.
else throws an error

Method: POST

Relative URL: probe/add

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
probe	Probe

Response Structure:

Field Name	Type	Description
response	RecordID

Example Request:

ADDPROBE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "probeType":"?",
   "probeParameters":"?",
   "archive":?,
   "sensorId":?,
   "sensorName":"?",
   "uniqueId":"?"
}

Example Response:

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

archiveProbe POST Interface

archiveRiskService(POST) is called when user wants to delete risk Record.

It checks for RecordId that the user wants to delete.

If Id is found, then the record is deleted.

else it throws an error

Method: POST

Relative URL: probe/archive

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
probeId	RecordID

Response Structure:

Field Name	Type	Description
response	RecordID

Example Request:

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

Example Response:

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

editProbe POST Interface

editRiskService(POST) is called when user wants to edit the risk Record.

The Id of the Record the user wants to edit is checked.

If Id is found, then the record can be edited.

else it throws an error

Any field can be edited by the user, if the record with id is found.

Method: POST

Relative URL: probe/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
probe	Probe

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITPROBE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "probeType":"?",
   "probeParameters":"?",
   "archive":?,
   "sensorId":?,
   "sensorName":"?",
   "uniqueId":"?"
}

Example Response:

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