Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Services Endpoints

 

Use the references for REST API V8.0 services endpoints.

POST /services/dig_lookups

Creates a new DIG lookup. Lookup completes in the background.

Table 1: POST /services/dig_lookups Resource Details

MIME Type

application/json

Table 2: POST /services/dig_lookups Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

IP

query

Required

String

text/plain

Used to retrieve the DIG 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/dig_lookups Response Codes

HTTP Response Code

Unique Code

Description

201

 

The DIG lookup was created successfully.

500

1020

An internal server error occurred during the creation of the DIG lookup.

Response Description

A DIG Lookup object, and the location header that is set to the task status URL "/services/dig_lookups/{dig_lookup_id}". A DIG Lookup object contains the following fields:

  • id - Long - The ID of the DIG lookup.

  • ip - String - The IP address to be investigated.

  • message - String - The result of the DIG lookup when it is 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>" }

GET /services/dig_lookups/{dig_lookup_id}

Retrieves the DIG Lookup status and result. The result is included if the lookup completed.

Table 4: GET /services/dig_lookups/{dig_lookup_id} Resource Details

MIME Type

application/json

Table 5: GET /services/dig_lookups/{dig_lookup_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

dig_lookup_id

path

Required

Number (Integer)

text/plain

Required - The ID of the Dig lookup 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 6: GET /services/dig_lookups/{dig_lookup_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The DIG lookup Status was retrieved.

404

1002

The DIG lookup status does not exist.

500

1020

An error occurred during the attempt to retrieve the DIG lookup status.

Response Description

A DIG Lookup object, and the location header that is set to the task status URL "/services/dig_lookups/{dig_lookup_id}". A DIG Lookup object contains the following fields:

  • id - Long - The ID of the DIG lookup.

  • ip - String - The IP address to be investigated.

  • message - String - The result of the DIG lookup when it is 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>" }

POST /services/dns_lookups

Creates a new DNS lookup. Lookup completes in the background.

Table 7: POST /services/dns_lookups Resource Details

MIME Type

application/json

Table 8: POST /services/dns_lookups Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

IP

query

Required

String

text/plain

Used to retrieve the DNS 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 9: POST /services/dns_lookups Response Codes

HTTP Response Code

Unique Code

Description

201

 

The DNS lookup was successfully created.

500

1020

An internal server error occurred during the creation of the DNS lookup.

Response Description

A DNS Lookup object and the location header set to the task status URL "/services/dns_lookups/{dns_lookup_id}". A DNS status object contains the following fields:

  • id - Long - The ID of the DNS lookup.

  • ip - String - The IP address to be investigated.

  • message - String - The result of the DNS lookup when it is 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>" }

GET /services/dns_lookups/{dns_lookup_id}

Retrieves the DNS Lookup status. The result is included if the lookup completes.

Table 10: GET /services/dns_lookups/{dns_lookup_id} Resource Details

MIME Type

application/json

Table 11: GET /services/dns_lookups/{dns_lookup_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

dns_lookup_id

path

Required

Number (Integer)

text/plain

Required - The ID of the DNS lookup 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 12: GET /services/dns_lookups/{dns_lookup_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The DNS lookup status was retrieved.

404

1002

The DNS lookup status does not exist.

500

1020

An error occurred during the attempt to retrieve the DNS lookup status.

Response Description

A DNS Lookup object, and the location header set to the task status URL "/services/dns_lookups/{dns_lookup_id}". A DNS status object contains the following fields:

  • id - Long - The ID of the DNS lookup.

  • ip - String - The IP address to be investigated.

  • message - String - The result of the DNS lookup when it is 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>" }

POST /services/port_scans

Creates a new port scan lookup. This endpoint is not available on SaaS systems. It return a 404 error.

Table 13: POST /services/port_scans Resource Details

MIME Type

application/json

Table 14: 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 15: 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 address to be investigated.

  • message - String - The result of the port scan when it is 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>" }

GET /services/port_scans/{port_scan_id}

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

Table 16: GET /services/port_scans/{port_scan_id} Resource Details

MIME Type

application/json

Table 17: 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 18: 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.

  • 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>" }

POST /services/whois_lookups

Creates a new WHOIS lookup. Lookup completes in the background.

Table 19: POST /services/whois_lookups Resource Details

MIME Type

application/json

Table 20: POST /services/whois_lookups Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

IP

query

Required

String

text/plain

Used to retrieve the WHOIS 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 21: POST /services/whois_lookups Response Codes

HTTP Response Code

Unique Code

Description

201

 

The WHOIS lookup was created successfully.

500

1020

An internal server error occurred during the creation of the WHOIS lookup.

Response Description

A WHOIS lookup object, and the location header that is set to the task status URL "/services/whois_lookups/{whois_lookup_id}". A WHOIS status object contains the following fields:

  • id - Long - The ID of the WHOIS lookup.

  • ip - String - The IP address to be investigated.

  • message - String - The result of the WHOIS lookup 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>" }

GET /services/whois_lookups/{whois_lookup_id}

Retrieves the WHOIS lookup status. The result is included if the lookup completes.

Table 22: GET /services/whois_lookups/{whois_lookup_id} Resource Details

MIME Type

application/json

Table 23: GET /services/whois_lookups/{whois_lookup_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

whois_lookup_id

path

Required

Number (Integer)

text/plain

Required - The ID of the WHOIS lookup 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 24: GET /services/whois_lookups/{whois_lookup_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The WHOIS lookup status was retrieved.

404

1002

The WHOIS lookup status does not exist.

500

1020

An error occurred during the attempt to retrieve the WHOIS lookup status.

Response Description

A WHOIS lookup object, and the location header that is set to the task status URL "/services/whois_lookups/{whois_lookup_id}". A WHOIS status object contains the following fields:

  • id - Long - The ID of the WHOIS lookup.

  • ip - String - The IP address to be investigated.

  • message - String - The result of the WHOIS lookup when it is 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>" }