GET /services/whois_lookups/{whois_lookup_id}
Retrieves the WHOIS lookup status. The result is included if the lookup completes.
Retrieves the WHOIS lookup status.
MIME Type |
---|
application/json |
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 retrieve. |
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 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 to investigate.
- 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>"
}