Sign in
DNS Providers

Create a new DNS provider

Changed on

The provider's credentials will be tested before creation. If the connection test fails, the provider will not be created.

post/dns-providers

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/dns-providers
  • Auth: HTTP bearer

Request body

descriptionstring nullable

Optional description

namestring required

User-friendly name

provider_type'cloudflare' | 'bunny' | 'namecheap' | 'route53' | 'digitalocean' | 'gcp' | 'azure' | 'manual' | 'pebble' required

Supported DNS provider types

Example request

{
  "credentials": {
    "api_token": "your-api-token"
  },
  "name": "My Cloudflare"
}

Response

DNS provider created

created_atstring required
credentialsunknown required
descriptionstring nullable
flat_hostnames_supportedboolean required

Whether this provider benefits from the flat hostname mode (e.g. Cloudflare Universal SSL). The UI surfaces/recommends the Flat toggle when true.

idinteger required
is_activeboolean required
last_errorstring nullable
last_used_atstring nullable
namestring required
provider_typestring required
updated_atstring required

Changes

  • 4b228ebed583Revision changes
    • info

      added the new bunny enum value to the request property

    • info

      added subschema #1 to the request property oneOf list

  • 1dc3e6788214Revision changes
    • breaking

      removed the enum value bunny of the request property

    • breaking

      removed subschema #1 from the request property oneOf list