v1

latestSwagger 2.02026-07-174510.2 KB

post/submit

Request body

scan_idstring required

The scan id given to the agent identify this scan

ipstring required

The ip address that was scanned

tagsstring[]

The tags that apply the scanned ip address

scan_reason'automatic' | 'manual' | 'requested' required

The reason for performing this scan.

xml_datastring required

The .xml output from nmap

nmap_datastring required

The .nmap output from nmap

gnmap_datastring required

The .gnmap output from nmap

scan_startstring required

Timestamp when the agent started its scan

scan_stopstring required

Timestamp when the agent stopped its scan

is_upboolean

Whether the host was determined to be up or down

port_countinteger

Number of ports found if the host is up

timed_outboolean

True if the nmap process timed out

Response

The server was able to parse the response and handled it accordingly.

statusinteger required

An HTTP Status code

messagestring required

A human friendly error message

retryboolean

If true, retry the request, otherwise do not

Example response

{
  "status": 403,
  "message": "Can't not frobinate the foobar"
}