Skip to main content
DELETE
Withdraw a custom DNS zone from the cluster

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid4>
required
zone
string
required

The declared zone, in any spelling; it is normalised before the lookup.

Response

The withdrawn zone

success
boolean
required
zone
string
required
credential_name
string
provider
string | null

Declare only: how the zone is published ('cloudflare', 'webhook' or 'avura').

policy
string | null

Declare only: the external-dns policy the zone's controller runs ('upsert-only' for Cloudflare, 'sync' otherwise).

cloudflare_zone
string

Declare of a Cloudflare-bound zone only: the Cloudflare zone the records land in (the declared zone or the nearest ancestor zone).

dns_edit_access
enum<string>

Declare of a Cloudflare-bound zone only: 'granted' when Cloudflare listed DNS edit for the token on the zone, 'unknown' when Cloudflare did not report the token's permissions.

Available options:
granted,
unknown