Skip to content

Commit e813ccd

Browse files
RebeccaTamachirosdnts
authored andcommitted
[DNS] DNS Settings API endpoint link review (cloudflare#22853)
* First pass with find and replace * Fix deprecations yaml differentiating zone vs account * Update links to DNS settings for account * Fix broken link prior to review of disablement flow * Adjust disable instructions to account for current endpoint
1 parent 5ab6fb0 commit e813ccd

File tree

8 files changed

+13
-13
lines changed

8 files changed

+13
-13
lines changed

src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For zones on paid plans, you can choose to flatten all CNAME records. This optio
3535

3636
</TabItem> <TabItem label="API">
3737

38-
Make a `PATCH` request to the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint and set `flatten_all_cnames` to `true` in the request body.
38+
Make a `PATCH` request to the [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoint and set `flatten_all_cnames` to `true` in the request body.
3939

4040
</TabItem> </Tabs>
4141

src/content/docs/dns/foundation-dns/setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To enable advanced nameservers on an existing zone:
2525

2626
</TabItem> <TabItem label="API">
2727

28-
Use the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint to send a PATCH request like the following:
28+
Use the [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoint to send a PATCH request like the following:
2929

3030
<APIRequest
3131
path="/zones/{zone_id}/dns_settings"

src/content/docs/dns/nameservers/custom-nameservers/account-custom-nameservers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Cloudflare will assign an IPv4 and an IPv6 address to each ACNS name, and these
9292
</TabItem>
9393
<TabItem label="API">
9494

95-
Use the endpoint [Update DNS Settings for a Zone](/api/resources/dns/subresources/settings/methods/edit/) and configure the `nameservers` object accordingly for each zone.
95+
Use the endpoint [Update DNS Settings for a Zone](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) and configure the `nameservers` object accordingly for each zone.
9696

9797
</TabItem>
9898
</Tabs>
@@ -120,7 +120,7 @@ Refer to [DNS zone defaults](/dns/nameservers/nameserver-options/#dns-zone-defau
120120
</TabItem>
121121
<TabItem label="API">
122122

123-
Use the endpoint [Update DNS Settings for an Account](/api/resources/dns/subresources/settings/methods/edit/). Within the `zone_defaults` object, set the following:
123+
Use the endpoint [Update DNS Settings for an Account](/api/resources/dns/subresources/settings/subresources/account/methods/edit/). Within the `zone_defaults` object, set the following:
124124

125125
```txt
126126
"zone_defaults": {
@@ -148,8 +148,8 @@ To remove ACNS from a zone, first update your nameservers to stop using ACNS:
148148
</TabItem>
149149
<TabItem label="API">
150150

151-
* If you are using [Cloudflare Registrar](/registrar/), use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) to change the `enabled` parameter to `false`, and then [contact Cloudflare Support](/support/contacting-cloudflare-support/) to set your nameservers back to the regular Cloudflare branded nameservers.
152-
* If you are not using [Cloudflare Registrar](/registrar/), modify the domain's registrar to use your regular Cloudflare branded nameservers and then use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) to set the `enabled` parameter to `false`.
151+
* If you are using [Cloudflare Registrar](/registrar/), use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) to set the `type` parameter in the `nameservers` object to `"cloudflare.standard"`. Then, [contact Cloudflare Support](/support/contacting-cloudflare-support/) to set your nameservers back to the regular Cloudflare branded nameservers.
152+
* If you are not using [Cloudflare Registrar](/registrar/), modify the domain's registrar to use your regular Cloudflare branded nameservers and then use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) to set the `type` parameter in the `nameservers` object to `"cloudflare.standard"`.
153153

154154
</TabItem>
155155
</Tabs>

src/content/docs/dns/nameservers/custom-nameservers/tenant-custom-nameservers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If the parameter `ns_set` is omitted, the default set `1` will be assigned.
5757

5858
2. If you are **not** using [Cloudflare Registrar](/registrar/), update the nameservers at your registrar to use the TCNS names. If you are using [Cloudflare Registrar](/registrar/), no further action is needed.
5959

60-
To make these TCNS the default namerservers for all new zones added to your account from now on, use the endpoint [Update DNS Settings for an Account](/api/resources/dns/subresources/settings/methods/edit/). Within the `zone_defaults` object, set the following:
60+
To make these TCNS the default namerservers for all new zones added to your account from now on, use the endpoint [Update DNS Settings for an Account](/api/resources/dns/subresources/settings/subresources/account/methods/edit/). Within the `zone_defaults` object, set the following:
6161

6262
```txt
6363
"zone_defaults": {

src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Follow the steps below to achieve this conversion.
1818

1919
1. [Export a zone file](/dns/manage-dns-records/how-to/import-and-export/#export-records).
2020
2. Import the zone file into your new primary DNS provider.
21-
3. At your Cloudflare zone, use the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint to enable [secondary DNS overrides](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/). Set the value for `secondary_overrides` to `true`.
21+
3. At your Cloudflare zone, use the [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoint to enable [secondary DNS overrides](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/). Set the value for `secondary_overrides` to `true`.
2222

2323
:::note
2424
Enabling secondary DNS overrides is necessary in case you have DNS records that you wish to keep <GlossaryTooltip term="proxy status" link="/dns/proxy-status/">proxied</GlossaryTooltip>.

src/content/docs/dns/zone-setups/conversions/convert-partial-to-secondary.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Final records adjusted in the zone file:
8787
<Render file="zone-file-size-limit" /> Existing and already proxied records
8888
will not be overwritten by the import.
8989

90-
2. Use the [Update DNS Settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) with `secondary_overrides` set to `true`, to enable Secondary DNS Override.
90+
2. Use the [Update DNS Settings endpoint](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) with `secondary_overrides` set to `true`, to enable Secondary DNS Override.
9191

9292
:::caution
9393

src/content/docs/dns/zone-setups/conversions/convert-secondary-to-full.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Follow the steps below to achieve this conversion.
2727
- If you have [Secondary DNS override](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/), confirm each record has the appropriate setting (**Proxied** or **DNS only**).
2828
- If [Secondary DNS override](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/) is disabled, make sure all of your DNS records are listed as **DNS only**.
2929

30-
3. (Optional) For consistency, use the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint to specify SOA record fields according to your needs. Once Cloudflare automatically generates an SOA record for your zone on full setup, the field overrides will be considered.
30+
3. (Optional) For consistency, use the [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoint to specify SOA record fields according to your needs. Once Cloudflare automatically generates an SOA record for your zone on full setup, the field overrides will be considered.
3131

3232
## 3. Convert your zone
3333

src/content/release-notes/api-deprecations.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ entries:
4040
description: |-
4141
Deprecation date: June 8, 2025
4242
43-
The Zone Settings API endpoints for managing zone-level CNAME flattening are deprecated. Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoints to manage this setting.
43+
The Zone Settings API endpoints for managing zone-level CNAME flattening are deprecated. Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoints to manage this setting.
4444
4545
Changes via the old endpoints will be reflected in the new ones, and vice versa, so there is no need to migrate existing zones. However, future API calls must use DNS Settings instead of the Zone Settings endpoints.
4646
@@ -181,7 +181,7 @@ entries:
181181
Deprecation date: March 14, 2025
182182
183183
The fields `"default_nameservers"` and `"use_account_custom_ns_by_default"` within the `"settings"` object of accounts are deprecated.
184-
Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoints to manage this setting.
184+
Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/subresources/account/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/account/methods/edit/) endpoints to manage this setting.
185185
This setting is available in the new API as `.zone_defaults.nameservers.type`, with allowed values `"cloudflare.standard"`, `"cloudflare.standard.random"`, `"custom.account"` and `"custom.tenant"`.
186186
187187
Changes via the old endpoints will be reflected in the new ones, and vice versa, so there is no need to migrate existing zones. However, future API calls must use DNS Settings instead of the Accounts endpoints.
@@ -384,7 +384,7 @@ entries:
384384
385385
The dedicated endpoints for DNS settings `use_apex_ns` and `secondary_overrides` are being deprecated.
386386
387-
Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoints to manage these settings.
387+
Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoints to manage these settings.
388388
389389
- Instead of the `.../use_apex_ns` endpoint, use the `multi_provider` field.
390390
- Instead of the `.../secondary_overrides` endpoint, use the `secondary_overrides` field.

0 commit comments

Comments
 (0)