GET /services/dig_lookups/{dig_lookup_id}
Retrieves the DIG lookup status. The result is included if the lookup completed.
Retrieves the DIG Lookup status and result.
MIME Type |
---|
application/json |
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. |
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 to investigate.
- message - String - The result of the DIG 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>"
}