Endpoint

/v1/authoritative-dns/settings

GET

Retrieve current Authoritative DNS Configuration

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "authoritative_dns_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "fqdn": {
      "description": "fqdn",
      "type": "string"
    },
    "host_restrictions": {
      "description": "host_restrictions",
      "type": "string"
    }
  }
}

PATCH

Modify current Authoritative DNS configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_authoritative_dns_config_patch",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "fqdn": {
      "description": "fqdn",
      "type": "string"
    },
    "host_restrictions": {
      "description": "host_restrictions",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "authoritative_dns_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "fqdn": {
      "description": "fqdn",
      "type": "string"
    },
    "host_restrictions": {
      "description": "host_restrictions",
      "type": "string"
    }
  }
}