API deprecations
Cloudflare occasionally makes updates to our APIs that result in behavior changes or deprecations. When this happens, we will communicate when the API will no longer be available and whether there will be a replacement.
Deprecation date: January 15, 2025
The Firewall Rules API and the Filters API are deprecated, since Firewall Rules was deprecated in favor of WAF custom rules. Refer to Firewall Rules to WAF custom rules migration for more information about this change.
Deprecated APIs:
GET /zones/:zone_id/firewall/rulesPOST /zones/:zone_id/firewall/rulesPATCH /zones/:zone_id/firewall/rulesPUT /zones/:zone_id/firewall/rulesDELETE /zones/:zone_id/firewall/rulesGET /zones/:zone_id/firewall/rules/:rule_idPATCH /zones/:zone_id/firewall/rules/:rule_idPUT /zones/:zone_id/firewall/rules/:rule_idDELETE /zones/:zone_id/firewall/rules/:rule_idGET /zones/:zone_id/filtersPOST /zones/:zone_id/filtersPUT /zones/:zone_id/filtersDELETE /zones/:zone_id/filtersGET /zones/:zone_id/filters/:filter_idPUT /zones/:zone_id/filters/:filter_idDELETE /zones/:zone_id/filters/:filter_id
Replacement: WAF custom rules
Deprecation date: January 15, 2025
The APIs for managing WAF managed rules (previous version) — namely for managing packages, rule groups, rules, and overrides — are deprecated in favor of WAF Managed Rules. Refer to WAF Managed Rules migration for more information about this change.
Deprecated APIs:
GET /zones/:zone_id/firewall/waf/packagesGET /zones/:zone_id/firewall/waf/packages/:package_idPATCH /zones/:zone_id/firewall/waf/packages/:package_idGET /zones/:zone_id/firewall/waf/packages/:package_id/groupsGET /zones/:zone_id/firewall/waf/packages/:package_id/groups/:group_idPATCH /zones/:zone_id/firewall/waf/packages/:package_id/groups/:group_idGET /zones/:zone_id/firewall/waf/packages/:package_id/rulesGET /zones/:zone_id/firewall/waf/packages/:package_id/rules/:rule_idPATCH /zones/:zone_id/firewall/waf/packages/:package_id/rules/:rule_idGET /zones/:zone_id/firewall/waf/overridesPOST /zones/:zone_id/firewall/waf/overridesGET /zones/:zone_id/firewall/waf/overrides/:override_idPUT /zones/:zone_id/firewall/waf/overrides/:override_idDELETE /zones/:zone_id/firewall/waf/overrides/:override_id
Replacement: WAF Managed Rules (new version)
Deprecation date: January 15, 2025
The Rate Limiting API is deprecated, since the previous version of rate limiting rules was deprecated in favor of the new rate limiting rules based on the Ruleset Engine. Refer to Rate limiting (previous version) deprecation notice for more information about this change.
Deprecated API:
GET /zones/:zone_id/rate_limitsPOST /zones/:zone_id/rate_limitsGET /zones/:zone_id/rate_limits/:rate_limit_idPUT /zones/:zone_id/rate_limits/:rate_limit_idDELETE /zones/:zone_id/rate_limits/:rate_limit_id
Replacement: Rate limiting rules (new version)
Deprecation date: November 30, 2024
Currently, each individual DNS record returned by the API contains information about the zone it is on, specifically the zone ID and name.
{
"result": [
{
// ...
"zone_id": "ab922473c42f4e50819d7c1c9b81b16b",
"zone_name": "example.com"
}
],
// ...
}
This information is redundant because both affected API routes are already within the zone scope. In particular, the zone ID will already be known to any user of these routes because it appears in the URL. The zone name can be retrieved by making a GET request to /zones/:zone_id if it is necessary.
After November 30th, 2024, Cloudflare will stop including the zone_id and zone_name fields on individual DNS records in API responses. These fields are currently ignored when sent to the API as part of a request body, so no changes to request bodies are required.
Modified API:
GET /zones/:zone_id/dns_recordsPOST /zones/:zone_id/dns_recordsGET /zones/:zone_id/dns_records/:dns_record_idPATCH /zones/:zone_id/dns_records/:dns_record_idPUT /zones/:zone_id/dns_records/:dns_record_id
Deprecation date: October 1, 2024
Cloudflare is making a minor change to the representation of certain errors when creating DNS records. Currently, when the DNS record to be created is invalid, an error similar to the following may be returned:
{
"result": null,
"success": false,
"errors": [
{
"code": 1004,
"message": "DNS Validation Error",
"error_chain": [
{
"code": 9999,
"message": "This is an example."
}
]
}
],
"messages": []
}
After October 1st, 2024, the error_chain will be omitted, returning the root cause directly without wrapping it in another "DNS Validation Error" error:
{
"result": null,
"success": false,
"errors": [
{
"code": 9999,
"message": "This is an example."
}
],
"messages": []
}
Deprecation date: September 13, 2024
The dedicated endpoints for DNS settings use_apex_ns and secondary_overrides are being deprecated.
Instead, use the Show DNS Settings and Update DNS Settings endpoints to manage these settings.
- Instead of the
.../use_apex_nsendpoint, use themulti_providerfield. - Instead of the
.../secondary_overridesendpoint, use thesecondary_overridesfield.
Deprecated APIs:
GET /zones/:zone_id/dns_settings/use_apex_nsPATCH /zones/:zone_id/dns_settings/use_apex_nsGET /zones/:zone_id/dns_settings/secondary_overridesPATCH /zones/:zone_id/dns_settings/secondary_overrides
Deprecation date: August 15, 2024
The Brotli setting and its API endpoints are deprecated. After the end of life date, Brotli compression will be enabled by default for all zones.
Deprecated APIs:
GET /zones/:zone_id/settings/brotliPATCH /zones/:zone_id/settings/brotli
Enterprise customers can override Cloudflare's default compression behavior using Compression Rules.
Deprecation date: August 5, 2024
The Auto Minify API endpoints are deprecated since the Auto Minify feature was deprecated.
Deprecated APIs:
GET /zones/:zone_id/settings/minifyPATCH /zones/:zone_id/settings/minify
Deprecation date: July 14, 2024
The "locked" field of DNS records in API responses is unused and has been guaranteed to always be false for more than a year. This deprecation means that the field will be omitted from API responses entirely. If received from a client, the field will continue to be ignored, just as it is today.
Modified API:
GET /zones/:zone_id/dns_recordsPOST /zones/:zone_id/dns_recordsGET /zones/:zone_id/dns_records/:dns_record_idPATCH /zones/:zone_id/dns_records/:dns_record_idPUT /zones/:zone_id/dns_records/:dns_record_id
Deprecation date: June 30, 2024
This endpoint and its related APIs are deprecated in favor of Single Redirects. Refer to Perform mobile redirects to migrate Mobile Redirect to Redirect Rules.
Deprecated API:
GET /zones/:zone_identifier/settings/mobile_redirectPATCH /zones/:zone_identifier/settings/mobile_redirect
Replacement: Single Redirects
Deprecation date: June 14, 2024
The Server-side Excludes feature and its API endpoints are deprecated.
Deprecated APIs:
GET /zones/:zone_id/settings/server_side_excludePATCH /zones/:zone_id/settings/server_side_exclude
Deprecation date: May 31, 2024
The name of an SRV record normally consists of three parts: the service (e.g., _xmpp), the protocol (e.g., _tcp), and the base name (example.com).
The complete name would then be, e.g., _xmpp._tcp.example.com.
When interacting with DNS records through the API, SRV records contain both a full name as well as a data map containing the individual components of the name:
{
"name": "_xmpp._tcp.example.com",
"data": {
"service": "_xmpp",
"proto": "_tcp",
"name": "example.com",
...
},
...
}
We are deprecating the service, proto and name fields within the data map in favor of the name field outside the data map, which is the same name field that's used by all other record types.
Before the end of life date, please ensure that:
- when reading SRV records, you use only the
nameoutside of the data map and ignoreservice,protoandnamewithin the data map if they exist; and - when writing SRV records, you set the
nameoutside of the data map and do not setservice,protoornamewithin the data map.
After the end of life date, the API will stop producing the service, proto and name data fields, and if any of them are received from a client, an error will be returned.
This deprecation does not affect other SRV data fields not mentioned above (priority, weight, port, target) or data fields for any other record type other than SRV.
Modified API:
GET /zones/:zone_id/dns_recordsPOST /zones/:zone_id/dns_recordsGET /zones/:zone_id/dns_records/:dns_record_idPATCH /zones/:zone_id/dns_records/:dns_record_idPUT /zones/:zone_id/dns_records/:dns_record_id
Deprecation date: March 31, 2024
In 2017, Cloudflare announced support for Privacy Pass, a recent protocol to let users prove their identity across multiple sites anonymously without enabling tracking. The initial use case was to provide untraceable tokens to sites to vouch for users who might otherwise have been presented with a CAPTCHA challenge. In the time since this release, Privacy Pass has evolved both at the IETF and within Cloudflare. The version announced in 2017 is now considered legacy, and these legacy Privacy Pass tokens are no longer supported as an alternative to Cloudflare challenges. As has been discussed on our blog The end road for CAPTCHA, Cloudflare uses a variety of signals to infer if incoming traffic is likely automated. The (legacy) Privacy Pass zone setting is no longer meaningful to Cloudflare customers as Cloudflare now operates CAPTCHA free, and supports the latest Privacy Pass draft.
In September 2023, support for legacy Privacy Pass tokens as an alternative to Cloudflare Managed Challenge was removed. By the end of March 2024, the current public-facing API will be removed as well.
Deprecated API:
GET zones/:zone_identifier/settings/privacy_passPOST zones/:zone_identifier/settings/privacy_pass
Deprecation date: February 4, 2024
This endpoint and its related APIs are deprecated in favor of the Cloudflare Tunnels equivalent APIs.
Deprecated API:
GET accounts/:account_identifier/tunnelsPOST accounts/:account_identifier/tunnelsGET accounts/:account_identifier/tunnels/:tunnel_idDELETE accounts/:account_identifier/tunnels/:tunnel_id
Replacement: Cloudflare Tunnel API
Deprecation date: July 1, 2023
Back in 2016, Cloudflare introduced support for ChaCha20-Poly1305 cipher suites for TLS 1.2. At the time, we introduced two variants of these new suites, the "standard" suites as defined by the IETF RFC 7905, and "draft" suites that followed an earlier draft of said specification. The draft suites were added for compatibility with some older Android devices that at the time did not yet support the proper ChaCha20-Poly1305 standard versions. This was in 2016, and in the meantime the standard ChaCha20-Poly1305 cipher suites have gained much wider adoption, to the point were traffic using the old suites has dropped significantly. Due to the current low usage and the non-standard nature of these cipher suites, we are now deprecating their support on the Cloudflare network.
This should not affect customer zones in any way, as clients that might currently use these cipher suites will be able to fallback to different ones. In addition, unlike the standard variants, these legacy cipher suites are not exposed directly through our API (e.g. through the TLS cipher suites preferences endpoint), and their deprecation will not affect customer configurations in any way.
As of July 1st, 2023, the ChaCha20-Poly1305 ciphers have been deprecated and are deemed End of Life by Cloudflare. If you have clients that currently rely on these ciphers, it is strongly recommended to upgrade them to newer, more secure ciphers. Be aware that these deprecated ciphers will be completely removed in the first quarter of 2024, and requests using them will start to fail. Take proactive measures to ensure a smooth transition and maintain the security of your systems.
Deprecation date: July 1, 2023
Previously, RFC 2616 allowed the use of Transfer-Encoding and Content-Length HTTP headers in the same request. RFC 7230 supersedes RFC 2616 and prohibits the use of Transfer-Encoding and Content-Length headers in the same request because they can cause HTTP request smuggling vulnerabilities.
Starting on July 1st, 2023, Cloudflare will decline requests with both Transfer-Encoding and Content-Length HTTP headers.
Deprecation date: June 6, 2023
There is no API replacement for these endpoints. As an alternative, please log in to your Cloudflare account to view your:
Deprecated API:
GET accounts/{account_identifier}/billing/profileGET user/billing/profileGET user/billing/history
Deprecation date: April 3, 2023
This field is deprecated and has been moved to Cloudflare centralized notification service.
notification_email is the email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
Deprecation date: March 19, 2023
This endpoint is deprecated in favor of using a specialized Access Application App Type API.
Deprecated API:
GET accounts/:identifier/access/bookmarksGET accounts/:identifier/access/bookmarks/:uuidPOST accounts/:identifier/access/bookmarks/:uuidPUT accounts/:identifier/access/bookmarks/:uuidDELETE accounts/:identifier/access/bookmarks/:uuid
Replacement: Access applications app type API
Deprecation date: October 11, 2022
Replace script_monitor in Page Shield API routes with page_shield.
Deprecation date: July 1, 2022
This endpoint is deprecated in favor of using v2, which allows you to control metadata, define an access policy, and get the image ID.
Deprecated API:
POST accounts/:account_identifier/images/v1/direct_upload
Replacement:
POST accounts/:account_identifier/images/v2/direct_upload
Deprecation date: March 1, 2021
This API is deprecated in favor of the GraphQL Analytics API, which provides equivalent data and more features, including the ability to select only the metrics that you need. For more information, refer to the Zone analytics to GraphQL analytics migration guide.
Deprecated API:
GET zones/:zone_identifier/analytics/dashboardGET zones/:zone_identifier/analytics/colos
Replacement: GraphQL Analytics API
Deprecation date: April 2, 2020
This endpoint and its related APIs are deprecated in favor of the /accounts equivalent API, which has a broader range of features and is backwards compatible with the /organizations API.
Deprecated API:
GET organizations/:identifierPATCH organizations/:identifierGET organizations/:organization_identifier/invitesPOST organizations/:organization_identifier/invitesGET organizations/:organization_identifier/invites/:identifierPATCH organizations/:organization_identifier/invites/:identifierDELETE organizations/:organization_identifier/invites/:identifierGET organizations/:organization_identifier/membersGET organizations/:organization_identifier/members/:identifierPATCH organizations/:organization_identifier/members/:identifierDELETE organizations/:organization_identifier/members/:identifierGET organizations/:organization_identifier/rolesGET organizations/:organization_identifier/roles/:identifierGET organizations/:organization_identifier/audit_logsGET organizations/:organization_identifier/railgunsPOST organizations/:organization_identifier/railgunsGET organizations/:organization_identifier/railguns/:identifierPATCH organizations/:organization_identifier/railguns/:identifierDELETE organizations/:organization_identifier/railguns/:identifierGET organizations/:organization_identifier/railguns/:identifier/zones
Replacement: Accounts API