POST /services/whois_lookups

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

Creates a new WHOIS lookup.

Table 1. POST /services/whois_lookups resource details
MIME Type
application/json

Table 2. 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 3. 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 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>"
}