Endpoint

/v1/dns/resolve-names-to-ips

POST

Resolve a list of hostnames to their set of associated IP addresses.

Parameters

This resource has no parameters.

Request

Schema

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_resolved_hostname",
    "type": "object",
    "properties": {
      "hostname": {
        "description": "The hostname which was resolved",
        "type": "string"
      },
      "ip_addresses": {
        "type": "array",
        "items": {
          "description": "The IP addresses to which the hostname resolved",
          "type": "string"
        }
      },
      "result": {
        "type": "string",
        "enum": [
          "OK",
          "ERROR",
          "NOT_FOUND",
          "TIMEOUT"
        ],
        "description": "The status of the resolution:\n * `ERROR` - DNS_RESOLUTION_ERROR,\n * `NOT_FOUND` - DNS_RESOLUTION_NOT_FOUND,\n * `OK` - DNS_RESOLUTION_OK,\n * `TIMEOUT` - DNS_RESOLUTION_TIMEOUT"
      }
    }
  }
}