Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /services/port_scans

 

Creates a new PortScans lookup. Port scan completes in the background.

Creates a new port scan lookup Not Available on SAAS systems, will return a 404 error.

Table 1: POST /services/port_scans Resource Details

MIME Type

application/json

Table 2: POST /services/port_scans Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

IP

query

Required

String

text/plain

Used to retrieve the port scan lookup.

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: POST /services/port_scans Response Codes

HTTP Response Code

Unique Code

Description

201

 

he PortScans lookup was created successfully.

500

1020

An internal server error occurred during the creation of the port scan lookup.

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