GET /services/port_scans/{port_scan_id}

Retrieves the port scan status. The result is included if the port scan completes.

Retrieves the port scan status.

Table 1. GET /services/port_scans/{port_scan_id} resource details
MIME Type
application/json

Table 2. GET /services/port_scans/{port_scan_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
port_scan_id	path	Required	Number (Integer)	text/plain	Required - The ID of the port scan to be retrieved.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /services/port_scans/{port_scan_id} response codes
HTTP Response Code	Unique Code	Description
200		The port scan status was retrieved.
404	1002	The port scan sStatus does not exist.
500	1020	An error occurred during the attempt to retrieve the port scan status.

Response Description

A port scan object and the location header set to the task status url "/services/port_scans/{port_scan_id}". A port scan status object contains the following fields:

id - Long - The ID of the port scan.
ip - String - The IP to investigate.
message - String - The result of the port scan when complete.
status - String - The current state of the task.

Response Sample


{
    "id": 42,
    "ip": "String",
    "message": "String",
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}