PATCH /zones/{zone_id}/dns_settings
Update DNS settings for a zone
Servers
- https://api.cloudflare.com/client/v4
Path parameters
Name | Type | Required | Description |
---|---|---|---|
zone_id |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
multi_provider |
Boolean | No |
Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the zone apex during outbound zone transfers. |
ns_ttl |
Number | No |
The time to live (TTL) of the zone's nameserver (NS) records. |
secondary_overrides |
Boolean | No |
Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex. |
soa |
Object | No |
Components of the zone's SOA record. |
soa.ttl |
Number | Yes |
The time to live (TTL) of the SOA record itself. |
soa.refresh |
Number | Yes |
Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated. |
soa.min_ttl |
Number | Yes |
The time to live (TTL) for negative caching of records within the zone. |
soa.retry |
Number | Yes |
Time in seconds after which secondary servers should retry queries after the primary server was unresponsive. |
soa.rname |
String | Yes |
The email address of the zone administrator, with the first label representing the local part of the email address. |
soa.expire |
Number | Yes |
Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone. |
soa.mname |
String | Yes |
The primary nameserver, which may be used for outbound zone transfers. |
internal_dns |
Object | No |
Settings for this internal zone. |
internal_dns.reference_zone_id |
String | No |
The ID of the zone to fallback to. |
nameservers |
Object | No |
Settings determining the nameservers through which the zone should be available. |
nameservers.type |
String | Yes |
Nameserver type Possible values:
|
nameservers.ns_set |
Integer | No |
Configured nameserver set to be used for this zone |
flatten_all_cnames |
Boolean | No |
Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened. |
foundation_dns |
Boolean | No |
Whether to enable Foundation DNS Advanced Nameservers on the zone. |
zone_mode |
String | No |
Whether the zone mode is a regular or CDN/DNS only zone. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.