Cloudflare 偶尔会对 API 进行更新,导致行为变更或弃用。发生这种情况时,我们会告知 API 何时不再可用,以及是否会有替代方案。
弃用日期:2026 年 7 月 21 日
Account Roles API 目前仅返回账户级别的角色,现已弃用,改用 Permission Groups API。Permission Groups API 是枚举可授予账户成员的账户级、zone 级和资源级角色的受支持方式。
已弃用的 API:
GET /accounts/{account_id}/roles— 列出角色GET /accounts/{account_id}/roles/{role_id}— 角色详情
替代 API:
GET /accounts/{account_id}/iam/permission_groups— 列出账户权限组GET /accounts/{account_id}/iam/permission_groups/{permission_group_id}— 权限组详情
响应架构与旧版 Roles 响应不同:
- 旧版
Role响应包含顶层的description,以及一个按资源类型作为键、带有编辑/读取标志的permissions对象。 PermissionGroup响应将上述内容替换为包含label和scopes的meta对象。单个权限不会作为权限组的一部分返回。
其他说明:
- 迁移到 Permission Groups API 的集成必须从该 API 获取 Permission Group ID,并在 Account Members API 的策略请求结构中使用这些 ID。持久化保存旧版 Role ID 的集成需要重新映射其分配。
- 两个端点都使用标准的 Cloudflare 响应封装,因此分页和错误处理方式不变。
- 新 API 支持 API 令牌授权方案。旧版的电子邮件 + API 密钥授权方案仅为向后兼容而提供。
- 受影响的 Terraform 资源是
cloudflare_account_role数据源。您需要迁移到cloudflare_account_permission_group数据源。
弃用日期:2026 年 7 月 15 日
停止服务日期:2026 年 10 月 15 日
/accounts/{account_id}/workers/namespaces/* 下的旧版 Workers KV API 路由已弃用,改用 /accounts/{account_id}/storage/kv/namespaces/* 下的 Workers KV API 路由。
旧版路由与替代路由可以互换使用。它们接受相同的请求参数并返回相同的响应负载。要进行迁移,请将 URL 路径从 /workers/namespaces/ 更新为 /storage/kv/namespaces/。
已弃用的 API:
GET和POST /accounts/{account_id}/workers/namespaces(列出和创建命名空间)GET、PUT和DELETE /accounts/{account_id}/workers/namespaces/{namespace_id}(获取、重命名和删除命名空间)GET /accounts/{account_id}/workers/namespaces/{namespace_id}/keys(列出键)GET /accounts/{account_id}/workers/namespaces/{namespace_id}/metadata/{key_name}(读取键元数据)GET、PUT和DELETE /accounts/{account_id}/workers/namespaces/{namespace_id}/values/{key_name}(读取、写入和删除键值对)
替代 API:
在每个端点中,将 URL 路径从 /workers/namespaces/ 更新为 /storage/kv/namespaces/。
GET和POST /accounts/{account_id}/storage/kv/namespaces(列出和创建命名空间)GET、PUT和DELETE /accounts/{account_id}/storage/kv/namespaces/{namespace_id}(获取、重命名和删除命名空间)GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys(列出键)GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}(读取键元数据)GET、PUT和DELETE /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}(读取、写入和删除键值对)
2026 年 10 月 15 日之后,将不再支持对旧版 /accounts/{account_id}/workers/namespaces/* 路由的请求。请在该日期之前更新集成以使用文档中的 Workers KV API 端点,以确保服务不中断。
弃用日期:2026 年 7 月 9 日
停止服务日期:2026 年 10 月 5 日
Zero Trust Networks API 和 Cloudflare Tunnel API 的两项相关变更将于 2026 年 10 月 5 日生效。
路由端点
采用 CIDR 编码的路由端点已弃用,改用现有的、基于 route_id 的标准端点。
已弃用的 API:
POST /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}PATCH /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}DELETE /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}
替代 API:
POST /accounts/{account_id}/teamnet/routesPATCH /accounts/{account_id}/teamnet/routes/{route_id}DELETE /accounts/{account_id}/teamnet/routes/{route_id}
Cloudflare Tunnel 和 Cloudflare Mesh 连接
Cloudflare Tunnel 和 Cloudflare Mesh 节点(即 cfd_tunnel 和 warp_connector API 资源)的列表和获取响应中将移除 connections 数组。请查询专用的连接端点,而不是从隧道或节点对象中读取该字段。
受影响的 API:
GET /accounts/{account_id}/cfd_tunnelGET /accounts/{account_id}/cfd_tunnel/{tunnel_id}GET /accounts/{account_id}/warp_connectorGET /accounts/{account_id}/warp_connector/{tunnel_id}
替代 API:
GET /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectionsGET /accounts/{account_id}/warp_connector/{tunnel_id}/connections
完整的迁移指南(包括 curl 示例以及 cloudflared 和 Terraform 相关说明)请参阅 Cloudflare Tunnel 更新日志。
弃用日期:2025 年 9 月 18 日
停止服务日期:2026 年 6 月 23 日
AMP/SXG 功能已停止服务,且不会提供替代功能。不应再使用相关的 zone 设置 API 端点和 sxg 配置规则设置。
已弃用的 API:
GET /zones/{zone_id}/amp/sxgPUT /zones/{zone_id}/amp/sxg
已弃用的配置规则设置:
sxg
仪表板 UI 将不再显示与 AMP 或 sxg 设置相关的内容。用户可以使用 rulesets API 从其规则集中移除 sxg 参数。Terraform 中的弃用将在稍后进行,用户应从其 Terraform 配置中移除对 sxg 参数的引用。
弃用日期:2026 年 4 月 10 日
停止服务日期:2026 年 9 月 27 日
旧版 Registrar 域名管理端点已弃用,并将于 2026 年 9 月 27 日停止服务。这些端点已被新的 Registrar API 取代,新 API 提供域名搜索、可用性检查和注册功能。
已弃用的 API:
GET /accounts/{account_id}/registrar/domains— 列出域名GET /accounts/{account_id}/registrar/domains/{domain_name}— 获取域名PUT /accounts/{account_id}/registrar/domains/{domain_name}— 更新域名
替代 API:Registrar API
- 搜索可用域名 —
GET /accounts/{account_id}/registrar/domain-search - 检查域名可用性 —
POST /accounts/{account_id}/registrar/domain-check - 列出注册 —
GET /accounts/{account_id}/registrar/registrations - 创建注册 —
POST /accounts/{account_id}/registrar/registrations
使用旧版域名管理端点的客户和集成必须在 2026 年 9 月 27 日之前迁移到新的 Registrar API,以确保服务不中断。在此日期之后,旧版端点将不再可用。
弃用日期:2025 年 4 月 23 日
停止服务日期:2026 年 9 月 15 日
Zone Settings 批量 API 端点(可在单个请求中读取和编辑多个 zone 设置)已弃用,并将于 2026 年 9 月 15 日停止服务。请改用按设置划分的端点来读取和编辑单个 zone 设置。
已弃用的 API:
GET /zones/{zone_id}/settingsPATCH /zones/{zone_id}/settings
替代 API:
- 获取 zone 设置 —
GET /zones/{zone_id}/settings/{setting_id} - 编辑 zone 设置 —
PATCH /zones/{zone_id}/settings/{setting_id}
在单次调用中读取或编辑多个设置的集成必须在 2026 年 9 月 15 日之前迁移为按设置发送请求,以确保服务不中断。在此日期之后,批量端点将不再可用。
弃用日期:2025 年 11 月 3 日
停止服务日期:2026 年 7 月 15 日
网络策略的 Gateway Audit SSH 操作已弃用,并将于 2026 年 7 月 15 日完全移除。SSH with Access for Infrastructure 是管理和审计 SSH 访问的替代方案。
通过仪表板创建带有 action: "audit_ssh" 的新 Gateway 规则的功能已于 2024 年 12 月禁用。通过 API 和 Terraform 创建新规则的功能已于 2025 年 11 月 3 日禁用。通过仪表板、API 和 Terraform 编辑现有规则的功能已于 2026 年 1 月 15 日禁用。2026 年 7 月 15 日,所有剩余的 Audit SSH 规则都将停止工作。
已弃用的 API:
POST /accounts/{account_id}/gateway/rules— 不再接受创建带有action: "audit_ssh"的规则PUT /accounts/{account_id}/gateway/rules/{rule_id}— 不再接受编辑带有action: "audit_ssh"的规则
弃用日期:2026 年 3 月 19 日
停止服务日期:2026 年 9 月 30 日
Cloudflare API 的 Service Key 身份验证已弃用,并将于 2026 年 9 月 30 日移除。API 令牌能够提供 Service Key 的全部功能,并额外支持细粒度权限范围、过期时间和 IP 地址限制。
已弃用的行为:
- 使用
X-Auth-User-Service-Key标头对 API 请求进行身份验证。 - 通过 Cloudflare 仪表板或 API 生成新的 Service Key。从仪表板生成新 Service Key 的功能即将移除。
替代方案:
- 为您的用例创建具有相应权限的 API 令牌。API 令牌支持细粒度的范围限定、过期和撤销。
cloudflared 用户应确保其运行的是 2022 年 11 月或之后的版本,这些版本使用 API 令牌而不是 Service Key。origin-ca-issuer 用户应更新到支持 API 令牌身份验证的版本。
弃用日期:2026 年 1 月 23 日
停止服务日期:2026 年 6 月 30 日
通过 API 更改现有 DNS 记录类型的功能已弃用,2026 年 6 月 30 日之后将不再支持。
更改 DNS 记录的类型并不是一种自然的更新操作,通常还需要同时更改记录的内容。更新名称、TTL 或内容等属性是常见且安全的操作,但更改记录类型会带来额外的验证复杂性和一致性风险。
为了符合正确的 DNS 语义并降低运维风险,Cloudflare 将弃用对 DNS 记录类型原地更改的支持。Terraform v5 provider 中已采用此行为:更改记录类型会触发删除并重新创建操作,而不是更新。
已弃用的行为:
- 使用 DNS Records API 更改现有记录的类型。
替代行为:
删除现有 DNS 记录,然后使用所需的类型和内容创建新的 DNS 记录。
DELETE /zones/{zone_id}/dns_records/{dns_record_id}POST /zones/{zone_id}/dns_records使用 Batch DNS records API 在单个请求中执行这两项操作。
POST /zones/{zone_id}/dns_records/batch
依赖原地更新记录类型的客户和集成必须在 2026 年 6 月 30 日之前迁移到“删除并重新创建”的工作流程,以确保服务不中断。在此日期之后,将不再支持通过更新操作更改记录类型。
弃用日期:2025 年 12 月 9 日
停止服务日期:2026 年 12 月 1 日
以下 REST API 已弃用,并将于 2026 年 12 月 1 日停止服务。
Cloudflare 的 GraphQL Analytics API 完全支持所有现有功能,并提供更好的性能、灵活性和长期支持。使用 REST API 的集成需要在 2026 年 12 月 1 日之前迁移到新的 GraphQL API,以确保服务不中断。
已弃用的 API:
GET/zones/{zone_id}/dns_analytics/(DNS Analytics API)GET/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report(DNS Firewall Analytics API)
替代 API:
停止服务日期:2025 年 11 月 11 日
我们正在更改设备(Devices)的定义。设备将代表现实世界中的计算机,而用户与设备之间的关系将由一个新概念——注册(Registrations)来表示。
因此,多个字段将从 Devices 移至 Registrations,并且我们将弃用下列端点。
在启用了多用户模式的账户上,不支持已弃用的端点。
已弃用的 API:
GET /accounts/{account_id}/devicesGET /accounts/{account_id}/devices/{device_id}GET /accounts/{account_id}/devices/{device_id}/override_codesPOST /accounts/{account_id}/devices/revokePOST /accounts/{account_id}/devices/unrevoke
替代 API:
GET /accounts/{account_id}/devices/physical-devicesGET /accounts/{account_id}/devices/physical-devices/{device_id}GET /accounts/{account_id}/devices/registrationsGET /accounts/{account_id}/devices/registrations/{registration_id}GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codesPOST /accounts/{account_id}/devices/registrations/revokePOST /accounts/{account_id}/devices/registrations/unrevoke
弃用日期:2025 年 11 月
停止服务日期:2026 年 1 月
继 Cloudflare Mirage 弃用之后,以下用于管理 Mirage 设置的 API 端点现已弃用,并将于 2026 年 1 月停用。
已弃用的 API:
GET /zones/{zone_id}/settings/miragePATCH /zones/{zone_id}/settings/mirage
受影响的 API:
GET /zones/{zone_id}/pagerules/settings- Mirage 将从可用设置中移除。POST /zones/{zone_id}/pagerules- Mirage 参数将被移除。PATCH /zones/{zone_id}/pagerules/{rule_id}- Mirage 参数将被移除。PUT /zones/{zone_id}/pagerules/{rule_id}- Mirage 参数将被移除。GET /zones/{zone_id}/rulesets/{ruleset_id}-set_config操作中的 Mirage 参数将被移除。GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_id}-set_config操作中的 Mirage 参数将被移除。POST /zones/{zone_id}/rulesets-set_config操作中的 Mirage 参数将被移除。PUT /zones/{zone_id}/rulesets/{ruleset_id}-set_config操作中的 Mirage 参数将被移除。POST /zones/{zone_id}/rulesets/{ruleset_id}/rules-set_config操作中的 Mirage 参数将被移除。PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}-set_config操作中的 Mirage 参数将被移除。GET /accounts/{account_id}/rulesets/{ruleset_id}-set_config操作中的 Mirage 参数将被移除。GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_id}-set_config操作中的 Mirage 参数将被移除。POST /accounts/{account_id}/rulesets-set_config操作中的 Mirage 参数将被移除。PUT /accounts/{account_id}/rulesets/{ruleset_id}-set_config操作中的 Mirage 参数将被移除。POST /accounts/{account_id}/rulesets/{ruleset_id}/rules-set_config操作中的 Mirage 参数将被移除。PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}-set_config操作中的 Mirage 参数将被移除。
弃用日期:2025 年 10 月 15 日
停止服务日期:2026 年 4 月 15 日
Radar API 目前为每个数据集提供了多个 summary 和 timeseries groups 端点(例如 /radar/http/summary/device_type 和 /radar/http/timeseries_groups/device_type),它们的参数和架构几乎完全相同。
为了简化 API 并提高可维护性,这些端点将被替换为使用 {dimension} 路径参数的参数化端点。
已弃用的 API:
GET /radar/http/summary/device_typeGET /radar/http/summary/bot_classGET /radar/http/timeseries_groups/device_typeGET /radar/http/timeseries_groups/bot_class- 以下数据集的其他类似 summary 和 timeseries groups 端点:AI Bots、AI Inference、AS112、DNS、Email Routing、Email security、HTTP、Layer 3 Attacks、Layer 7 Attacks、Leaked Credential Checks
替代 API:
GET /radar/http/summary/{dimension}GET /radar/http/timeseries_groups/{dimension}- ...
其中,{dimension} 是必需的路径参数,列出了该数据集的所有可用维度。
直接调用 API(而不是通过 Cloudflare SDK 调用)的用户无需执行任何操作。 对于使用 SDK 的用户,我们建议更新为新的操作,以确保旧操作移除后的兼容性。
弃用日期:2025 年 7 月 1 日
停止服务日期:2026 年 1 月 1 日
Radar Verified Bots API 现已弃用,并将由新的 Bots API 取代。
已弃用的 API:
GET /radar/verified_bots/top/botsGET /radar/verified_bots/top/categories
替代 API:
GET /radar/bots/summary/botGET /radar/bots/summary/category
弃用日期:2025 年 7 月 1 日
Cloudflare DWeb Resolver 实验即将结束。
已弃用的 API:
- resolver.cloudflare-eth.com 上的 DoH 解析器
弃用日期:2025 年 6 月 15 日
由于 Firewall Rules 已被弃用并由 WAF 自定义规则取代,Firewall Rules API 和 Filters API 也已弃用。有关此变更的更多信息,请参阅 Firewall Rules 升级。
已弃用的 API:
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
替代方案:WAF 自定义规则
弃用日期:2025 年 6 月 15 日
用于管理 WAF 托管规则(旧版本)的 API(即用于管理包、规则组、规则和覆盖的 API)已弃用,改为使用 Rulesets API 管理新版 WAF 托管规则。有关此变更的更多信息,请参阅 WAF 托管规则升级。
已弃用的 API:
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
替代方案:WAF 托管规则(新版本)
弃用日期:2025 年 6 月 15 日
Rate Limiting API 已弃用,改为使用 Rulesets API 管理新的速率限制规则。有关此变更的更多信息,请参阅速率限制(旧版本)升级。
已弃用的 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
替代方案:速率限制规则(新版本)
弃用日期:2025 年 6 月 8 日
用于管理 zone 级别 CNAME 展平的 Zone Settings API 端点已弃用。请改用 Show DNS Settings 和 Update DNS Settings 端点来管理此设置。
通过旧端点所做的更改会反映在新端点中,反之亦然,因此无需迁移现有 zone。但今后的 API 调用必须使用 DNS Settings,而不是 Zone Settings 端点。
请注意,对于已弃用的 zone 设置,值 "off" 和 "apex" 的行为相同。在新 API 中,它们表示为 {"flatten_all_cnames": false}。
zone 设置 "on" 对应新 API 中的 {"flatten_all_cnames": true}。
受影响的 API:
GET /zones/:zone_id/settingsPATCH /zones/:zone_id/settings
已弃用的 API:
GET /zones/:zone_id/settings/cname_flatteningPATCH /zones/:zone_id/settings/cname_flattening
弃用日期:2025 年 3 月 23 日
用户现在可以添加不属于其账户中所管理 zone 的自定义名称服务器。因此,任何 zone 都适用自定义名称服务器,无论其是否由 Cloudflare 管理。鉴于此变更,用于检查适用 zone 的端点已不再有意义,因此将被弃用。
已弃用的 API:
GET /accounts/:account_id/custom_ns/availability
弃用日期:2025 年 3 月 20 日
停止服务日期:2025 年 9 月 20 日
/top/industry 和 /top/vertical 攻击端点现已弃用,并将由相应的 summary 端点取代。
受影响的 API:
GET /radar/attacks/layer3/top/industryGET /radar/attacks/layer3/top/verticalGET /radar/attacks/layer7/top/industryGET /radar/attacks/layer7/top/vertical
替代 API:
GET /radar/attacks/layer3/summary/industryGET /radar/attacks/layer3/summary/verticalGET /radar/attacks/layer7/summary/industryGET /radar/attacks/layer7/summary/vertical
变更日期:2025 年 3 月 17 日
Cloudflare 现在会将 IP 地址威胁信号与阈值和僵尸网络数据相结合,您无需再设置敏感度级别。用户将无法再通过 Cloudflare 仪表板设置安全级别。不过,用户仍可以依靠现有的 API 或 Terraform 配置来设置安全级别。
如果您在规则表达式中使用了威胁评分,应检查这些表达式,以确保规则仍会在适当的时候触发。Cloudflare 将来会审核并迁移您的配置,以更新所有对威胁评分的引用。如果您使用 Rulesets API 或 Terraform 推送配置,应在 2026 年第一季度结束前检查您的脚本和管道,以避免出现问题。
弃用日期:2025 年 3 月 14 日
账户 "settings" 对象中的 "default_nameservers" 和 "use_account_custom_ns_by_default" 字段已弃用。
请改用 Show DNS Settings 和 Update DNS Settings 端点来管理此设置。
在新 API 中,此设置为 .zone_defaults.nameservers.type,允许的值为 "cloudflare.standard"、"cloudflare.standard.random"、"custom.account" 和 "custom.tenant"。
通过旧端点所做的更改会反映在新端点中,反之亦然,因此无需迁移现有 zone。但今后的 API 调用必须使用 DNS Settings,而不是 Accounts 端点。
受影响的 API:
GET /accountsPOST /accountsGET /accounts/:account_idPUT /accounts/:account_id
弃用日期:2025 年 3 月 11 日
停止服务日期:2025 年 6 月 11 日
第 7 层攻击的 magnitude 查询参数已弃用。该参数允许您按缓解的请求总数(MITIGATED_REQUESTS)或受攻击的 zone 总数(AFFECTED_ZONES)定义攻击规模。
今后,Cloudflare Radar 将仅支持根据缓解的请求总数来定义第 7 层攻击规模。
受影响的 API:
GET /radar/attacks/layer7/top/attacks
替代方案:
用户应停止使用 magnitude 参数,因为默认行为已使用 MITIGATED_REQUESTS。
弃用日期:2025 年 2 月 21 日
以下用于筛选 DNS 记录的 URL 参数已弃用:
name=contains:value请改用受支持的name.contains=value语法。name=starts_with:value请改用受支持的name.startswith=value语法。name=ends_with:value请改用受支持的name.endswith=value语法。name=one,two,three(搜索以逗号分隔的多个可能名称之一) 请改为发出多个请求,每个可能的name对应一个请求。 或者,如果仅查询name字段,也可以改用?match=any&name=one&name=two&name=three语法。 此语法的弃用日期延长至 2025 年 5 月 23 日。content=contains:value请改用受支持的content.contains=value语法。content=starts_with:value请改用受支持的content.startswith=value语法。content=ends_with:value请改用受支持的content.endswith=value语法。content=one,two,three(搜索以逗号分隔的多个可能内容之一) 请改为发出多个请求,每个可能的content对应一个请求。 或者,如果仅查询content字段,也可以改用?match=any&content=one&content=two&content=three语法。 此语法的弃用日期延长至 2025 年 5 月 23 日。type=contains:value将不再支持搜索类型名称的子字符串。 请改为搜索确切的类型名称,例如type=CNAME。 如果输入值是来自人工用户的自由文本搜索,请考虑改用search参数。
根据我们的 API 文档,所有被弃用的参数从未得到过官方支持。
受影响的 API:
GET /zones/:zone_id/dns_records
弃用日期:2025 年 11 月 21 日
Access 应用程序的 self_hosted_domains 字段已弃用,改用 destinations,以便更灵活地定义不同类型的域名。
之前:
{
// ...
"self_hosted_domains": ["foo.example.com", "bar.example.com"]
}
之后:
{
// ...
"destinations": [
{
"type": "public",
"uri": "foo.example.com"
},
{
"type": "public",
"uri": "bar.example.com"
}
]
}
在弃用日期之前,API 将同时接受这两个字段。如果提供了 self_hosted_domains,它们将被解释为 public 目标。但如果提供了 destinations,则即使提供了 self_hosted_domains 也会被忽略。
此外,在弃用日期之前,API 将继续返回 self_hosted_domains。该字段将包含类型为 public 的那部分目标的 URI。
受影响的 API:
GET /accounts/:account_id/access/appsPOST /accounts/:account_id/access/appsGET /accounts/:account_id/access/apps/:app_idPUT /accounts/:account_id/access/apps/:app_idGET /zones/:zone_id/access/appsPOST /zones/:zone_id/access/appsGET /zones/:zone_id/access/apps/:app_idPUT /zones/:zone_id/access/apps/:app_id
弃用日期:2024 年 11 月 30 日
目前,API 返回的每条 DNS 记录都包含其所在 zone 的信息,具体为 zone ID 和名称。
{
"result": [
{
// ...
"zone_id": "ab922473c42f4e50819d7c1c9b81b16b",
"zone_name": "example.com"
}
],
// ...
}
这些信息是冗余的,因为两个受影响的 API 路由本身就在 zone 范围内。特别是,这些路由的任何用户都已经知道 zone ID,因为它出现在 URL 中。如有必要,可以通过向 /zones/:zone_id 发送 GET 请求来获取 zone 名称。
2024 年 11 月 30 日之后,Cloudflare 将不再在 API 响应的单个 DNS 记录中包含 zone_id 和 zone_name 字段。目前,当这些字段作为请求正文的一部分发送到 API 时会被忽略,因此无需更改请求正文。
修改的 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
弃用日期:2024 年 10 月 1 日
Cloudflare 将对创建 DNS 记录时某些错误的表示方式进行一项小幅变更。目前,当要创建的 DNS 记录无效时,可能会返回类似以下的错误:
{
"result": null,
"success": false,
"errors": [
{
"code": 1004,
"message": "DNS Validation Error",
"error_chain": [
{
"code": 9999,
"message": "This is an example."
}
]
}
],
"messages": []
}
2024 年 10 月 1 日之后,将省略 error_chain,直接返回根本原因,而不再将其包装在另一个“DNS Validation Error”错误中:
{
"result": null,
"success": false,
"errors": [
{
"code": 9999,
"message": "This is an example."
}
],
"messages": []
}
弃用日期:2024 年 9 月 13 日
DNS 设置 use_apex_ns 和 secondary_overrides 的专用端点即将弃用。
请改用 Show DNS Settings 和 Update DNS Settings 端点来管理这些设置。
- 使用
multi_provider字段代替.../use_apex_ns端点。 - 使用
secondary_overrides字段代替.../secondary_overrides端点。
已弃用的 API:
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
弃用日期:2024 年 8 月 15 日
Brotli 设置及其 API 端点已弃用。Brotli 压缩已适用于所有非 Enterprise zone,并将在未来一年内扩展到 Enterprise zone。
已弃用的 API:
GET /zones/:zone_id/settings/brotliPATCH /zones/:zone_id/settings/brotli
Enterprise 客户可以使用压缩规则覆盖 Cloudflare 的默认压缩行为。
弃用日期:2024 年 8 月 5 日
由于 Auto Minify 功能已弃用,Auto Minify API 端点也随之弃用。
已弃用的 API:
GET /zones/:zone_id/settings/minifyPATCH /zones/:zone_id/settings/minify
弃用日期:2024 年 7 月 14 日
API 响应中 DNS 记录的 "locked" 字段未被使用,并且一年多以来始终保证为 false。此次弃用意味着该字段将从 API 响应中完全省略。如果从客户端收到该字段,它将继续像现在一样被忽略。
修改的 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
弃用日期:2024 年 6 月 30 日
此端点及其相关 API 已弃用,改用 Single Redirects。要将移动端重定向迁移到重定向规则,请参阅执行移动端重定向。
已弃用的 API:
GET /zones/:zone_identifier/settings/mobile_redirectPATCH /zones/:zone_identifier/settings/mobile_redirect
替代方案:Single Redirects
弃用日期:2024 年 6 月 14 日
Server-side Excludes 功能及其 API 端点已弃用。
已弃用的 API:
GET /zones/:zone_id/settings/server_side_excludePATCH /zones/:zone_id/settings/server_side_exclude
弃用日期:2024 年 5 月 31 日
SRV 记录的名称通常由三部分组成:服务(例如 _xmpp)、协议(例如 _tcp)和基本名称(example.com)。
因此完整的名称例如为 _xmpp._tcp.example.com。
通过 API 操作 DNS 记录时,SRV 记录既包含完整的 name,也包含一个 data 映射,其中含有名称的各个组成部分:
{
"name": "_xmpp._tcp.example.com",
"data": {
"service": "_xmpp",
"proto": "_tcp",
"name": "example.com",
...
},
...
}
我们将弃用 data 映射内部的 service、proto 和 name 字段,改用 data 映射外部的 name 字段,即所有其他记录类型都使用的同一个 name 字段。
在停止服务日期之前,请确保:
- 读取 SRV 记录时,仅使用 data 映射外部的
name,并忽略 data 映射内部的service、proto和name(如果存在);并且 - 写入 SRV 记录时,设置 data 映射外部的
name,并且不要设置 data 映射内部的service、proto或name。
停止服务日期之后,API 将不再生成 service、proto 和 name 数据字段;如果从客户端收到其中任何字段,将返回错误。
此次弃用不影响上文未提及的其他 SRV 数据字段(priority、weight、port、target),也不影响 SRV 以外任何其他记录类型的数据字段。
修改的 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
弃用日期:2024 年 3 月 31 日
2017 年,Cloudflare 宣布支持 Privacy Pass。这是一项当时较新的协议,可让用户在多个站点上匿名证明自己的身份,且不会导致被跟踪。最初的用例是向站点提供无法追踪的令牌,为原本可能会被要求完成 CAPTCHA 质询的用户提供担保。自该版本发布以来,Privacy Pass 在 IETF 和 Cloudflare 内部都在不断演进。2017 年发布的版本现已被视为旧版,这些旧版 Privacy Pass 令牌不再作为 Cloudflare 质询的替代方案得到支持。正如我们在博客文章 The end road for CAPTCHA 中所讨论的,Cloudflare 使用多种信号来推断传入流量是否可能为自动化流量。由于 Cloudflare 现在已实现无 CAPTCHA 运行,并支持最新的 Privacy Pass 草案,(旧版)Privacy Pass zone 设置对 Cloudflare 客户已不再有意义。
2023 年 9 月,已移除对将旧版 Privacy Pass 令牌作为 Cloudflare 托管质询替代方案的支持。到 2024 年 3 月底,当前面向公众的 API 也将被移除。
已弃用的 API:
GET zones/:zone_identifier/settings/privacy_passPOST zones/:zone_identifier/settings/privacy_pass
弃用日期:2024 年 2 月 4 日
此端点及其相关 API 已弃用,改用 Cloudflare Tunnel 的对应 API。
已弃用的 API:
GET accounts/:account_identifier/tunnelsPOST accounts/:account_identifier/tunnelsGET accounts/:account_identifier/tunnels/:tunnel_idDELETE accounts/:account_identifier/tunnels/:tunnel_id
替代方案: Cloudflare Tunnel API
弃用日期:2023 年 7 月 1 日
早在 2016 年,Cloudflare 就引入了对 TLS 1.2 ChaCha20-Poly1305 密码套件的支持。当时,我们引入了这些新套件的两个变体:一是 IETF RFC 7905 定义的“标准”套件,二是遵循该规范早期草案的“草案”套件。添加草案套件是为了兼容当时尚不支持正式 ChaCha20-Poly1305 标准版本的一些旧款 Android 设备。那是 2016 年的事,此后标准的 ChaCha20-Poly1305 密码套件得到了更广泛的采用,使用旧套件的流量已大幅下降。鉴于这些密码套件目前使用率很低且不符合标准,我们现在将弃用 Cloudflare 网络对它们的支持。
这不会对客户的 zone 产生任何影响,因为当前可能使用这些密码套件的客户端将能够回退到其他套件。此外,与标准变体不同,这些旧版密码套件并不会通过我们的 API(例如 TLS 密码套件偏好设置端点)直接公开,因此其弃用不会对客户配置产生任何影响。
自 2023 年 7 月 1 日起,ChaCha20-Poly1305 密码已被弃用,Cloudflare 视其为已停止服务。如果您的客户端目前依赖这些密码,强烈建议将其升级为更新、更安全的密码。请注意,这些已弃用的密码将在 2024 年第一季度被完全移除,使用它们的请求将开始失败。请主动采取措施,确保平稳过渡并维护系统安全。
弃用日期:2023 年 7 月 1 日
此前,RFC 2616 允许在同一请求中使用 Transfer-Encoding 和 Content-Length HTTP 标头。RFC 7230 取代了 RFC 2616,并禁止在同一请求中同时使用 Transfer-Encoding 和 Content-Length 标头,因为这可能导致 HTTP 请求走私漏洞。
从 2023 年 7 月 1 日起,Cloudflare 将拒绝同时带有 Transfer-Encoding 和 Content-Length HTTP 标头的请求。
弃用日期:2023 年 4 月 3 日
此字段已弃用,并已迁移到 Cloudflare 集中式通知服务。
notification_email 是接收健康状态通知的电子邮件地址,可以是个人邮箱或邮件列表。可以以逗号分隔列表的形式提供多个电子邮件地址。
弃用日期:2023 年 3 月 19 日
此端点已弃用,改用专门的 Access 应用程序 App Type API。
已弃用的 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
替代方案: Access 应用程序 App Type API
弃用日期:2022 年 7 月 1 日
此端点已弃用,改用 v2。v2 允许您控制元数据、定义访问策略并获取图像 ID。
已弃用的 API:
POST accounts/:account_identifier/images/v1/direct_upload
替代 API:
POST accounts/:account_identifier/images/v2/direct_upload
弃用日期:2021 年 3 月 1 日
此 API 已弃用,改用 GraphQL Analytics API。后者提供同等的数据和更多功能,包括只选择您所需指标的能力。有关详细信息,请参阅 Zone Analytics 迁移至 GraphQL Analytics 指南。
已弃用的 API:
GET zones/:zone_identifier/analytics/dashboardGET zones/:zone_identifier/analytics/colos
替代方案: GraphQL Analytics API
弃用日期:2020 年 4 月 2 日
此端点及其相关 API 已弃用,改用 /accounts 的对应 API,后者功能更丰富,并且向后兼容 /organizations API。
已弃用的 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
替代方案: Accounts API