Sign in
DNS Providers

Update a DNS provider

Changed on

If new credentials are supplied, they are tested before the update is persisted (same as creation) -- otherwise a provider's credentials (and, for Pebble, its target URL) could be swapped for something invalid or unsafe without ever going through validation.

put/dns-providers/{id}

Request

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

Path parameters

idinteger required

Request body

descriptionstring nullable

New description

is_activeboolean nullable

Active status

namestring nullable

New name

Example request

{
  "credentials": {
    "api_token": "your-api-token"
  }
}

Response

DNS provider updated

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 subschema #1 to the //// request property oneOf list

    • info

      added the non-success response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed subschema #1 from the //// request property oneOf list

    • info

      removed the non-success response with the status