Response Payload

The IP API and Hostname API return structured data in JSON response payloads.

Status Information

Standard HTTP response codes are sent by the API, along with the following status attributes (if available):

status_code: a status code number
status_message: a human-readable status message
status_fields: an array of validation errors (if any)

You can find more information about errors and validation on the response codes page.

Data Payload Information

The data attribute contains the core data provided by the APIs. You can find detailed information about the IP Objects and Hostname Objects returned in the data payload.

Pagination Information

Some Netify API endpoints provide data in paginated format. In order to manage payload sizes and caching, the pagination size is set to a value appropriate for the specific data feed. Essentially, our goal is to keep payload sizes below 50MB.

The page parameter lets you select the page number of the data set, e.g. https://..?page=2.

The data_info attribute of the API response provides page statistics. See adjacent JSON example.

Response Payload Example

{
   "status_code": 0,
   "status_message": "Success.",
   "data": ...
   "data_info": {
      "total_records": 1139,
      "total_pages": 12,
      "current_page": 1,
      "start": 1,
      "length": 100,
      "limit": 100
   },
}