Endpoint

/v1/dns/configs/system

GET

Get the system's DNS configuration.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_dns_config",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier for this DNS configuration.",
      "type": "number"
    },
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "The list of DNS servers associated with this DNS configuration.",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "The list of DNS search domains associated with this DNS configuration.",
        "type": "string"
      }
    },
    "lookup_overrides": {
      "type": "array",
      "items": {
        "description": "The list of DNS lookup overrides associated with this DNS configuration.",
        "type": "object",
        "properties": {
          "ip_address": {
            "description": "ip_address",
            "type": "string"
          },
          "aliases": {
            "type": "array",
            "items": {
              "description": "aliases",
              "type": "string"
            }
          }
        }
      }
    }
  }
}

PATCH

Update the system's DNS configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_system_dns_config_patch",
  "type": "object",
  "properties": {
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "The list of DNS servers associated with this DNS configuration.",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "The list of DNS search domains associated with this DNS configuration.",
        "type": "string"
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_dns_config",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier for this DNS configuration.",
      "type": "number"
    },
    "dns_servers": {
      "type": "array",
      "items": {
        "description": "The list of DNS servers associated with this DNS configuration.",
        "type": "string"
      }
    },
    "dns_search_domains": {
      "type": "array",
      "items": {
        "description": "The list of DNS search domains associated with this DNS configuration.",
        "type": "string"
      }
    },
    "lookup_overrides": {
      "type": "array",
      "items": {
        "description": "The list of DNS lookup overrides associated with this DNS configuration.",
        "type": "object",
        "properties": {
          "ip_address": {
            "description": "ip_address",
            "type": "string"
          },
          "aliases": {
            "type": "array",
            "items": {
              "description": "aliases",
              "type": "string"
            }
          }
        }
      }
    }
  }
}