Cloudflare MCP Server
Manage Cloudflare zones through 29 shared MCP/CLI tools: read-focused operations plus 11 explicitly confirmed mutations.
Read zones, DNS, Workers, Page Rules, and Rulesets — e.g.
list_zones,get_zone,list_dns_records,get_dns_record,list_workers,list_page_rules,list_zone_rulesets,get_zone_ruleset,get_zone_entrypoint,list_provider_accounts.Read and update zone settings —
get_zone_setting/update_zone_setting(SSL, cache level, security level, HSTS, and more).Create or change DNS records (confirmation required) —
create_dns_record,update_dns_record,overwrite_dns_record,delete_dns_record,batch_dns_records.Purge cache (confirmation required) — by files, tags, hosts, prefixes, or everything.
Modify Rulesets (confirmation required) —
create_zone_ruleset,update_zone_ruleset,delete_zone_ruleset, optionally withdry_run.Review DNS batches locally before applying —
preview_dns_batchreturns a SHA-256 digest;apply_dns_batchverifies it and submits once.Inspect schemas and preview requests locally —
get_operation_schema,preview_operation,list_accounts(no network).Bounded paginated reads —
query_pagesfetches up to 5 pages for accounts, zones, or DNS records.Read-only GraphQL analytics —
analytics_querywith one parsed query plus variables; no mutations.Safety controls — mandatory confirmation on mutations,
CLOUDFLARE_READ_ONLY,CLOUDFLARE_ALLOW_DESTRUCTIVE, isolated private profiles, optional audit log, and no automatic retries.
Provides tools for managing Cloudflare zones, DNS records, cache purging, zone settings, Rulesets, Worker metadata, and read-only analytics through the Cloudflare API, with confirmation-gated mutations for changes.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Cloudflare MCP Serverlist the DNS records for example.com and show my zones"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Cloudflare MCP Server & CLI
Cloudflare MCP server and CLI for Codex and AI agents. 29 tools for current DNS, cache, zone settings, Rulesets, Worker metadata and read-only analytics, with private accounts and explicit operation approval. One shared implementation supplies both binaries and a desktop bundle.
Built and maintained by Navid Moazzez. Built on Slipway, which turns one definition of each tool into the MCP server and the CLI. The complete guide is on navid.me.
The terminal illustrates real command names and approval flow. It is not a recording of a provider account run. Cloudflare already has official CLI and hosted MCP products; their current schemas, approval policies and supported workflows are compared below.
Requires Node 22+ and eligible Cloudflare API access for account operations. Validation: fixture tests, schema validation and protocol/artifact discovery are separate from provider-account outcomes and desktop GUI outcomes, which remain unverified. Section 7 has the measured token costs; no success rate is invented.
Two ways to use it
Command line
npm install -g @thenavidm/cloudflare-mcp-cli@latest
cloudflare-cli tools
cloudflare-cli list-zones --per-page 10 --agent
cloudflare-cli schema create-dns-record
cloudflare-cli create-dns-record --zone-id YOUR_ZONE_ID --payload-file /absolute/private/approved-dns.json --account work --confirm --agentMCP server, for your AI app
codex mcp add cloudflare -- npx -y @thenavidm/cloudflare-mcp-cli@latestConfigure private credentials first. Ask: “Read DNS for this exact zone; do not change any records.” Full setup is in INSTALL.md.
Which one
Where you work | Surface |
Codex or shell agent | Shared CLI, local MCP or both |
Desktop chat | Compatible local MCP or desktop bundle |
Scripts / CI | CLI or MCP client |
Remote-only client / broad API | Official Cloudflare hosted MCP / cf |
Workers deployment | Official Wrangler / cf |
Related MCP server: cloudflare-api-mcp
Features
Capability | CLI | MCP |
Zone/DNS reads | list-zones / list-dns-records | list_zones / list_dns_records |
Explicit DNS changes | create-dns-record / update-dns-record | create_dns_record / update_dns_record |
Exact DNS review/apply | preview-dns-batch / apply-dns-batch | preview_dns_batch / apply_dns_batch |
Rulesets and settings | get-zone-ruleset / get-zone-setting | get_zone_ruleset / get_zone_setting |
Bounded reads / analytics | query-pages / analytics-query | query_pages / analytics_query |
Local schemas / previews | get-operation-schema / preview-operation | get_operation_schema / preview_operation |
Profiles and policy | list-accounts / --account / --confirm | list_accounts / account / confirm |
Contents
Number | Section | What it covers |
1 | What you can ask it | |
2 | Quick install | |
3 | Set up Cloudflare access | |
4 | Connect your client | |
5 | Check it works | |
6 | Output, flags and exit codes | |
7 | MCP or CLI and token cost | |
8 | Every tool and argument | |
9 | DNS, Rulesets, cache and analytics | |
10 | Pagination, retries and local input files | |
11 | Several private accounts | |
12 | Writing safely | |
13 | How the two surfaces work | |
14 | Privacy and data handling | |
15 | Environment variables | |
16 | Updates and removal | |
17 | Troubleshooting | |
18 | API coverage and comparisons | |
19 | Versions | |
20 | FAQ |
1. What you can ask it
Read the intended zone's DNS records without changing anything.
Inspect the exact native schema for an A, AAAA, TXT, MX or other supported DNS request.
Preview a small reviewed DNS batch and submit only the same approved zone/profile/body.
Apply one explicit DNS edit or deletion after inspecting its record ID and content.
Read the selected zone setting, then change only the approved value.
Inspect current Rulesets and the selected phase entrypoint before approving a Ruleset change.
Purge only the requested cache targets after confirmation.
Query an eligible analytics dataset for an explicit time window without mutations.
Actual credential-free stdio discovery supplies 29 tools: 18 reads and 11 confirmation-gated mutations. Twenty-two native operations use a pinned, reviewed current REST schema; seven helpers provide local profile/schema/preview, bounded reads, DNS review/apply and query-only analytics. This is a focused management surface. It does not deploy Workers, expose an unrestricted raw API request or implement every Cloudflare product.
2. Quick install
npm install -g @thenavidm/cloudflare-mcp-cli@latest
cloudflare-cli --version
cloudflare-cli tools
cloudflare-cli schema create-dns-record
cloudflare-cli loginRequires Node 22+ for manual installs. Configure private tokens before provider calls. Discovery and local previews work without provider authentication. See INSTALL.md for macOS, Windows, Linux, every supported local client, Docker and desktop extension setup.
3. Set up Cloudflare access
Private API tokens and resource access
Choose the intended Cloudflare user/account and zone. Create a least-privilege API token through My Profile > API Tokens, or Manage account > Account API tokens for an account-owned token.
Choose only the permissions needed below and restrict account/zone resources. Check optional expiry and IP filters. Save the secret privately outside every repository; never use the Global API Key with this Bearer-only package.
Configure CLOUDFLARE_TOKEN_FILE as an absolute token-only file, or privately set CLOUDFLARE_API_TOKEN. Optional CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_ZONE_ID supply input defaults. A default does not restrict token permissions.
Run cloudflare-cli doctor for local configuration checks. Deliberately run doctor --network to verify token status: user tokens use GET /user/tokens/verify; account-owned tokens need CLOUDFLARE_TOKEN_KIND=account and a private account ID, using GET /accounts/{account_id}/tokens/verify. Only an active result is accepted; token IDs/status bodies are not printed.
Read the exact zone and DNS records, inspect the complete current input schema, preview the intended change locally and approve only the chosen request. A local preview does not verify provider permissions, conflicts or current remote state.
Requests use Authorization: Bearer on the fixed https://api.cloudflare.com/client/v4 origin. Token-kind selection changes the diagnostic route, not ordinary authorization or resource access. The wrapper does not implement OAuth login, refresh, saved official cf sessions, automatic .env loading or global CLI config ingestion. login prints instructions; it neither opens consent nor saves credentials.
User tokens inherit permitted user access. Account-owned tokens act as service principals; creation requires the provider's token-provisioning capability or Super Administrator role and grants cannot exceed the creator's permissions. Some products still have compatibility restrictions; verify the exact operation in the account-token compatibility documentation.
Intended task | Permission to review with the provider | Resource scope |
Discover zones / zone identity | Zone: Read | Intended zone(s) |
Read DNS records | DNS: Read | Intended zone(s) |
Create/edit/delete/batch DNS | DNS: Edit | Intended zone(s) |
Purge cache | Cache Purge permission | Intended zone(s) |
Read/change zone settings | Zone Settings: Read / Edit | Intended zone(s) and supported setting |
Read/change a Ruleset | The permission for its Ruleset phase, such as zone WAF or Transform Rules read/edit | Intended zone(s); phase/plan restrictions apply |
Worker script metadata | Workers Scripts: Read | Intended account(s) |
Query analytics | Analytics: Read and current dataset access | Intended account/zone(s) |
Read Page Rules | Page Rules: Read | Intended zone(s) |
List provider accounts | Account Settings: Read or provider-documented account listing grant | Accessible intended accounts |
Review API token permissions and the selected endpoint's accepted grant list; this table is task guidance, not a complete static authorization manifest. Do not grant token-management, account administration or every zone solely for installation.
Use a private 0700 directory and regular 0600 token-only file on macOS/Linux. Windows users must restrict the file ACL to their own user; POSIX checks do not establish Windows ACL protection. Token files cannot be symlinks or exceed 64 KiB. File credentials override environment credentials and are cached until restart. GUI applications may have a different environment from your terminal.
Plans and limits
This AGPL wrapper is free; Cloudflare services and plan restrictions remain separate. DNS, proxy, cache purge, setting values, Ruleset phases and analytics availability are controlled by Cloudflare. Read metadata for the selected setting or dataset rather than assuming every write is allowed on every plan.
Current general API limits list 1200 requests per five minutes for a user/account token and 200 per second per IP, with cumulative user limits and endpoint-specific exceptions. Other sessions and processes consume the same upstream quota. Local pacing defaults to 200 ms per profile/process; it does not reserve quota. No reads or mutations retry automatically after 429, timeout, network failure or HTTP 200 provider errors. Wait according to current provider response/reset policy and inspect state before a deliberate repeat.
GraphQL analytics limits separately describe a default 300-query/five-minute user quota, up to ten zones or one account per scoped query, and dataset-specific retention/record limits. The general limits table uses a different GraphQL maximum figure; use the current analytics rules and returned policy for the actual query. Account-based limiting can be enabled through provider controls; the wrapper does not opt you into it. Inspect the provider's settings node for your dataset and resource. Adaptive analytics may be sampled; an aggregate is not necessarily an exact event ledger.
Reviewed DNS batches have a local cap of 1–50 total actions, deliberately below many provider plan limits. The underlying native batch command uses the reviewed source schema and provider limits. Request JSON is capped at 1 MiB; responses at 5 MiB; GraphQL query text at 64 KiB and 10000 parsed tokens; default timeout is 30 seconds. These caps do not raise Cloudflare quotas or plan allowances.
Rotation and revocation
Revoke or rotate the selected user/account token in its Cloudflare settings, update private configuration and restart every client using it. npm uninstall does not revoke the token, restore DNS, remove Rulesets or undo a cache purge. Keep account exports, DNS TXT values, signed URLs and diagnostic responses out of public issues.
4. Connect your client
Codex is the primary documented agent. After private credential setup:
codex mcp add cloudflare -- npx -y @thenavidm/cloudflare-mcp-cli@latest
codex mcp listUse the private env_vars TOML configuration in INSTALL.md to forward token/profile settings. Fully restart an npx @latest server to resolve the latest npm release. An already-running process keeps its existing version.
Client | Setup route | Important detail |
Codex desktop / CLI | codex mcp add or private config.toml | Forward private env vars; choose CLI with SKILL.md for shell tasks |
Claude Desktop | Versioned .mcpb or manual local stdio | Set sensitive token/file, defaults and policy in private extension settings |
Claude Code | claude mcp add --scope user | Optional client; section 7 has its measured costs |
Cursor | Private user mcp.json | Interpolation/envFile must refer to private local settings |
VS Code / Copilot | User MCP configuration | servers root and secure input prompts |
Windsurf | Private Cascade MCP settings | Reconnect after changes |
Zed | context_servers | Direct command/args/env shape |
Gemini CLI | Private settings.json | Merge mcpServers and inspect /mcp |
Cline / other stdio clients | Add local MCP | Adapt command/args without committed credentials |
Remote-only clients | Official HTTPS MCP | This package supplies local stdio, no public listener |
The desktop archive vendors production dependencies. Host policies/runtime support and actual GUI installation remain separate from protocol discovery. INSTALL.md retains click-by-click steps and platform-specific launcher advice.
5. Check it works
cloudflare-cli doctor
cloudflare-cli doctor --network
cloudflare-cli list-accounts --agent
cloudflare-cli list-zones --per-page 10 --agent
cloudflare-cli get-zone --zone-id YOUR_ZONE_ID --agentLocal doctor reports configuration, not credentials validated. --network checks an active token through its configured token-kind route; it does not prove access to every endpoint. First provider read should be the exact zone needed for the task. Do not create DNS records or purge cache merely to verify installation.
Full discovery has 29 tools; CLOUDFLARE_READ_ONLY=1 hides eleven mutations and direct calls still refuse. Local helpers expose no tokens or provider IDs. A missing credential exits 10; a valid install is not proof of provider account access.
6. Output, flags and exit codes
The house CLI derives tool flags from the same input schemas used by MCP. Tool names use underscores in MCP and hyphens in the shell. Native path/query arguments are top-level flags; current native request bodies use --payload JSON or --payload-file PATH, never both. --select filters returned data locally; it does not change Cloudflare's upstream fields or quota.
Flag / command | Contract |
tools / no command | Discover every command; confirmed mutations are marked |
COMMAND --help | Actual tool schema arguments |
schema COMMAND | Complete JSON input schema, including native payload unions/references |
--agent | Compact JSON and no prompts; never confirms a write |
--json / --compact | Machine JSON, optionally compact |
--select a,b.c | Local dotted result selection |
--payload / --payload-file | Native JSON body / private regular JSON file |
--account NAME | Exact private profile label |
--confirm | Explicit intent for the selected mutation only |
--no-input / --no-color / --yes | Noninteractive formatting/prompt policy; no mutation permission |
Exit | Meaning |
0 | Success |
1 | Unexpected error |
2 | Invalid input or refused mutation, an unknown command or a hidden write |
3 | Not found |
4 | Authentication/permission error |
5 | Provider or transport failure |
7 | Rate limited |
10 | No credentials configured |
Provider REST results retain success/result/result_info envelopes; query-only analytics retains data. HTTP 200 with provider errors fails. JSON output is not proof that DNS has propagated or every downstream service accepted a setting.
7. MCP or CLI and token cost
Mode | What the client receives | Evidence required |
Local MCP | Tool descriptions/schemas according to the client's loading policy; returned provider data | Actual client/model usage for that loading mode |
Shared CLI | Discovered help/SKILL.md and chosen command output | Actual successful matched task usage |
Official Code Mode | Small docs/search/execute interface and generated execution/result | Its provider claims are not our Codex measurements |
Read-only / bounded output | Fewer exposed writes, bounded pages and local --select | Policy/output bounds, not a measured token reduction |
Measured on 2026-10-05 against 2.0.1, the same day, with Claude Code 2.1.286 on Claude Opus 5.5 (one short prompt with and without the server connected, the difference read from the API's own usage figures) and Codex 0.159.3 on gpt-6.1-sol:
Cost | 2.0.1 | 3.0.0 |
Claude Code, every tool loaded, every message | 230,145 | 144,067 |
Claude Code's default, tool search, every message | 608 | 611 |
| 3,930 | 4,014 |
Codex over the CLI, one task, median of five | 104,401 | 83,426 |
Codex over MCP, the same task, median of five | 40,548 | 41,139 |
The task was "find the command that purges a zone's cache, and the flags it requires". Every tool loaded costs less because each native body appeared twice, as its own fields and inside payload, and 3.0.0 writes each repeated part once under $defs. Over the CLI, three 2.0.1 runs guessed a command that does not exist, cache or schema with no name, and every extra step carries the whole conversation forward; every 3.0.0 run read the help, asked which and read purge-cache --help. Over MCP, Codex prints its own TypeScript rendering of the tools it picks: it leaves the argument descriptions out of a tool whose schema is large, and sharing the repeats brought purge_cache under that size, so Codex now shows how to purge by tags, hosts or prefixes, 2,344 characters that 2.0.1's rendering left out. SKILL.md costs 84 more because it now says how approval works over MCP and lists every exit code.
Do not compare 29 tools against three Code Mode tools as a winner or claim a universal CLI saving; no other offering was measured.
8. Every tool and argument
Twenty-two current native operations and seven helpers. Each schema below comes from actual stdio discovery. Native payload bodies preserve required keys, enums, unions, nested references and source constraints. Missing zone_id/account_id may use the selected private profile default; other required arguments remain required. Confirmation is enforced outside ordinary schema-required lists.
MCP tool | CLI command | Policy |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Read / local helper |
|
| Explicit confirmation required |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Explicit confirmation required |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Read / local helper |
|
| Explicit confirmation required |
|
| Read / local helper |
list_provider_accounts
cloudflare-cli list-provider-accounts
List all accounts you have ownership or verified access to. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Name of the account. |
| No; body and guard rules apply | number | Page number of paginated results. minimum: |
| No; body and guard rules apply | number | Maximum number of results per page. minimum: |
| No; body and guard rules apply | string | Direction to order results. Values: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /accounts; accounts-list-accounts. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
list_zones
cloudflare-cli list-zones
Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A domain name. Optional filter operators can be provided to extend refine the search: * |
| No; body and guard rules apply | string | Specify a zone status to filter by. Values: |
| No; body and guard rules apply | array | Zone types to filter by. Multiple types can be specified as a comma-separated list (e.g., ?type=full,partial,secondary). When this parameter is not provided, zones with type "internal" are excluded from the results. Items: string. |
| No; body and guard rules apply | string | Filter by an account ID. |
| No; body and guard rules apply | string | An account Name. Optional filter operators can be provided to extend refine the search: * |
| No; body and guard rules apply | number | Page number of paginated results. minimum: |
| No; body and guard rules apply | number | Number of zones per page. minimum: |
| No; body and guard rules apply | string | Field to order zones by. Values: |
| No; body and guard rules apply | string | Direction to order zones. Values: |
| No; body and guard rules apply | string | Whether to match all search requirements or at least one (any). Values: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones; zones-get. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
get_zone
cloudflare-cli get-zone
Retrieves detailed information about a specific zone identified by its zone ID.
Returns zone configuration, status, nameservers, and associated metadata. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}; zones-0-get. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
list_dns_records
cloudflare-cli list-dns-records
List, search, sort, and filter a zones' DNS records. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Exact value of the DNS record name. This is a convenience alias for |
| No; body and guard rules apply | string | Exact value of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | string | Substring of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | string | Prefix of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | string | Suffix of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | dns-records_type | See current schema |
| No; body and guard rules apply | string | Exact value of the DNS record content. This is a convenience alias for |
| No; body and guard rules apply | string | Exact value of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | string | Substring of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | string | Prefix of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | string | Suffix of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | dns-records_proxied | See current schema |
| No; body and guard rules apply | dns-records_match | See current schema |
| No; body and guard rules apply | string | Exact value of the DNS record comment. This is a convenience alias for |
| No; body and guard rules apply | string | If this parameter is present, only records with a comment are returned. |
| No; body and guard rules apply | string | If this parameter is present, only records without a comment are returned. |
| No; body and guard rules apply | string | Exact value of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Substring of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Prefix of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Suffix of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Condition on the DNS record tag. Parameter values can be of the form |
| No; body and guard rules apply | string | Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. |
| No; body and guard rules apply | string | Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive. |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | dns-records_search | See current schema |
| No; body and guard rules apply | dns-records_tag_match | See current schema |
| No; body and guard rules apply | dns-records_page | See current schema |
| No; body and guard rules apply | dns-records_per_page | See current schema |
| No; body and guard rules apply | dns-records_order | See current schema |
| No; body and guard rules apply | dns-records_direction | See current schema |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Filters the response to records at or below the specified NS delegation name. NS, DS, and NSEC records at the delegation name are excluded because they are not shadowed by that delegation. Those record types are included only when they exist below the delegation. The value must be a non-apex subdomain of the zone. Requires |
| No; body and guard rules apply | string | Returns NS records that shadow the given name, searching at the name itself and each of its ancestor names within the zone, excluding the zone apex. The value must be a subdomain of the zone; the zone apex is not accepted. See Shadowed records. |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/dns_records; dns-records-for-a-zone-list-dns-records. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
get_dns_record
cloudflare-cli get-dns-record
Retrieves details for a specific DNS record in the zone. Read operation.
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/dns_records/{dns_record_id}; dns-records-for-a-zone-dns-record-details. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
create_dns_record
cloudflare-cli create-dns-record
Create a new DNS record for a zone.
Notes:
A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: POST /zones/{zone_id}/dns_records; dns-records-for-a-zone-create-dns-record. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
update_dns_record
cloudflare-cli update-dns-record
Update an existing DNS record.
Notes:
A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: PATCH /zones/{zone_id}/dns_records/{dns_record_id}; dns-records-for-a-zone-patch-dns-record. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
overwrite_dns_record
cloudflare-cli overwrite-dns-record
Overwrite an existing DNS record.
Notes:
A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: PUT /zones/{zone_id}/dns_records/{dns_record_id}; dns-records-for-a-zone-update-dns-record. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
delete_dns_record
cloudflare-cli delete-dns-record
Permanently removes a DNS record from the zone. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
Native operation: DELETE /zones/{zone_id}/dns_records/{dns_record_id}; dns-records-for-a-zone-delete-dns-record. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
batch_dns_records
cloudflare-cli batch-dns-records
Send a Batch of DNS Record API calls to be executed together.
Notes:
Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare's distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See the documentation for more information.
The operations you specify within the /batch request body are always executed in the following order:
Deletes
Patches
Puts
Posts Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: POST /zones/{zone_id}/dns_records/batch; dns-records-for-a-zone-batch-dns-records. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
purge_cache
cloudflare-cli purge-cache
Deletes cached content in every Cloudflare data center and cache tier, including Cache Reserve. The next request for purged content is a cache MISS: Cloudflare fetches the full response from your origin and caches it again. Cloudflare does not serve purged content from cache again, even if your origin is unavailable.
To keep content cached and have Cloudflare revalidate it with your origin instead, use POST /zones/{zone_id}/invalidate_cache.
Choose what to purge
Send one of these fields in the request body:
files: specific URLs. If your cache key includes request headers, send each URL with the header values it was cached with.tags: all content whoseCache-Tagresponse header contains one of the tags.hosts: all content cached for the hostnames.prefixes: all content whose URL starts with one of the prefixes.purge_everything: all cached content in the zone.
Check the result
A 200 response with success: true means Cloudflare accepted the request. It does not confirm that any content was cached or removed. To check, request a purged URL and confirm that the CF-Cache-Status response header is MISS.
Availability and limits
Rate limits and the number of items you can send in one request depend on your plan. See Purge cache: availability and limits. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| No; body and guard rules apply | cache-purge_identifier | The zone ID. minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | Union | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: POST /zones/{zone_id}/purge_cache; zone-purge. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
get_zone_setting
cloudflare-cli get-zone-setting
Fetch a single zone setting by name Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier | See current schema minLength: |
| Yes | zones_setting_name | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/settings/{setting_id}; zone-settings-get-single-setting. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
update_zone_setting
cloudflare-cli update-zone-setting
Updates a single zone setting by the identifier Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier | See current schema minLength: |
| Yes | zones_setting_name | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | Union | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: PATCH /zones/{zone_id}/settings/{setting_id}; zone-settings-edit-single-setting. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
list_workers
cloudflare-cli list-workers
Fetch a list of uploaded Worker scripts. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | workers_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'. |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /accounts/{account_id}/workers/scripts; worker-script-list-workers. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
list_zone_rulesets
cloudflare-cli list-zone-rulesets
Fetches all rulesets at the zone level. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | rulesets_Cursor | See current schema |
| No; body and guard rules apply | rulesets_PerPage | See current schema |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/rulesets; listZoneRulesets. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
get_zone_ruleset
cloudflare-cli get-zone-ruleset
Fetches the latest version of a zone ruleset. Read operation.
Argument | Required | Type | Details |
| Yes | rulesets_RulesetId | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/rulesets/{ruleset_id}; getZoneRuleset. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
get_zone_entrypoint
cloudflare-cli get-zone-entrypoint
Fetches the latest version of the zone entry point ruleset for a given phase. Read operation.
Argument | Required | Type | Details |
| Yes | rulesets_RulesetPhase | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint; getZoneEntrypointRuleset. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
create_zone_ruleset
cloudflare-cli create-zone-ruleset
Creates a ruleset at the zone level. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | boolean | Validates the request without persisting changes when set to |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | JSON | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: POST /zones/{zone_id}/rulesets; createZoneRuleset. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
update_zone_ruleset
cloudflare-cli update-zone-ruleset
Updates a zone ruleset, creating a new version. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| Yes | rulesets_RulesetId | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | boolean | Validates the request without persisting changes when set to |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | JSON | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
Native operation: PUT /zones/{zone_id}/rulesets/{ruleset_id}; updateZoneRuleset. Native body required through payload or payload_file. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
delete_zone_ruleset
cloudflare-cli delete-zone-ruleset
Deletes all versions of an existing zone ruleset. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
Argument | Required | Type | Details |
| Yes | rulesets_RulesetId | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | boolean | Validates the request without persisting changes when set to |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
Native operation: DELETE /zones/{zone_id}/rulesets/{ruleset_id}; deleteZoneRuleset. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
list_page_rules
cloudflare-cli list-page-rules
Fetches Page Rules in a zone. Read operation.
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier-2 | See current schema minLength: |
| No; body and guard rules apply | string | The field used to sort returned Page Rules. Values: |
| No; body and guard rules apply | string | The direction used to sort returned Page Rules. Values: |
| No; body and guard rules apply | string | When set to |
| No; body and guard rules apply | string | The status of the Page Rule. Values: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/pagerules; page-rules-list-page-rules. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
get_page_rule
cloudflare-cli get-page-rule
Fetches the details of a Page Rule. Read operation.
Argument | Required | Type | Details |
| Yes | zones_identifier-2 | See current schema minLength: |
| No; body and guard rules apply | zones_identifier-2 | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
Native operation: GET /zones/{zone_id}/pagerules/{pagerule_id}; page-rules-get-a-page-rule. Native body not required. Schema discovery is local; endpoint permissions/plan decisions remain provider controlled.
list_accounts
cloudflare-cli list-accounts
Local profile labels/default/auth method only. No provider IDs, credential values or paths. No network.
Argument | Required | Type | Details |
None | No | None | No arguments |
get_operation_schema
cloudflare-cli get-operation-schema
Complete selected current API input, path and query schema. Local metadata only.
Argument | Required | Type | Details |
| Yes | string | See the full input schema. Values: |
preview_operation
cloudflare-cli preview-operation
Validate a named operation and return its exact local method/path/query/body/profile. No request, auth validation or provider policy checks.
Argument | Required | Type | Details |
| Yes | string | See the full input schema. Values: |
| Yes | object | See the full input schema. |
query_pages
cloudflare-cli query-pages
Read at most five pages of a supported paginated named operation. Provider page metadata determines continuation; missing metadata stops with an explicit unknown continuation.
Argument | Required | Type | Details |
| Yes | string | See the full input schema. Values: |
| Yes | object | See the full input schema. |
| No; body and guard rules apply | integer | See the full input schema. minimum: |
preview_dns_batch
cloudflare-cli preview-dns-batch
Local schema-validated DNS batch review capped at 50 actions. Digest binds exact JSON body, zone path and profile label; no account or DNS state read. Not a provider authorization grant.
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. minLength: |
| No; body and guard rules apply | string | See the full input schema. |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. minLength: |
apply_dns_batch
cloudflare-cli apply-dns-batch
Verify the reviewed digest and submit one exact native DNS batch with mandatory confirmation. Does not assert remote-state consistency or atomic DNS propagation; no retry.
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. minLength: |
| No; body and guard rules apply | string | See the full input schema. |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. minLength: |
| Yes | string | See the full input schema. pattern: |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
analytics_query
cloudflare-cli analytics-query
One parsed GraphQL query only, with variables. No mutations, subscriptions or multiple operations. Permissions, dataset retention, sampling and query limits remain provider controlled.
Argument | Required | Type | Details |
| Yes | string | See the full input schema. minLength: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
Nested native input definitions
Identical object shapes are listed once below. References point to the named definitions; union branches retain their individual requirements. Some provider JSON-schema conditions do not fit a flat table; use schema COMMAND or get_operation_schema for complete validation. Unknown native root body keys are refused locally; provider constraints still apply.
list_provider_accounts
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Name of the account. |
| No; body and guard rules apply | number | Page number of paginated results. minimum: |
| No; body and guard rules apply | number | Maximum number of results per page. minimum: |
| No; body and guard rules apply | string | Direction to order results. Values: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
list_zones
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A domain name. Optional filter operators can be provided to extend refine the search: * |
| No; body and guard rules apply | string | Specify a zone status to filter by. Values: |
| No; body and guard rules apply | array | Zone types to filter by. Multiple types can be specified as a comma-separated list (e.g., ?type=full,partial,secondary). When this parameter is not provided, zones with type "internal" are excluded from the results. Items: string. |
| No; body and guard rules apply | string | Filter by an account ID. |
| No; body and guard rules apply | string | An account Name. Optional filter operators can be provided to extend refine the search: * |
| No; body and guard rules apply | number | Page number of paginated results. minimum: |
| No; body and guard rules apply | number | Number of zones per page. minimum: |
| No; body and guard rules apply | string | Field to order zones by. Values: |
| No; body and guard rules apply | string | Direction to order zones. Values: |
| No; body and guard rules apply | string | Whether to match all search requirements or at least one (any). Values: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
get_zone
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
list_dns_records
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Exact value of the DNS record name. This is a convenience alias for |
| No; body and guard rules apply | string | Exact value of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | string | Substring of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | string | Prefix of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | string | Suffix of the DNS record name. Name filters are case-insensitive. |
| No; body and guard rules apply | dns-records_type | See current schema |
| No; body and guard rules apply | string | Exact value of the DNS record content. This is a convenience alias for |
| No; body and guard rules apply | string | Exact value of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | string | Substring of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | string | Prefix of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | string | Suffix of the DNS record content. Content filters are case-insensitive. |
| No; body and guard rules apply | dns-records_proxied | See current schema |
| No; body and guard rules apply | dns-records_match | See current schema |
| No; body and guard rules apply | string | Exact value of the DNS record comment. This is a convenience alias for |
| No; body and guard rules apply | string | If this parameter is present, only records with a comment are returned. |
| No; body and guard rules apply | string | If this parameter is present, only records without a comment are returned. |
| No; body and guard rules apply | string | Exact value of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Substring of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Prefix of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Suffix of the DNS record comment. Comment filters are case-insensitive. |
| No; body and guard rules apply | string | Condition on the DNS record tag. Parameter values can be of the form |
| No; body and guard rules apply | string | Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. |
| No; body and guard rules apply | string | Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive. |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | string | A tag and value, of the form |
| No; body and guard rules apply | dns-records_search | See current schema |
| No; body and guard rules apply | dns-records_tag_match | See current schema |
| No; body and guard rules apply | dns-records_page | See current schema |
| No; body and guard rules apply | dns-records_per_page | See current schema |
| No; body and guard rules apply | dns-records_order | See current schema |
| No; body and guard rules apply | dns-records_direction | See current schema |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Filters the response to records at or below the specified NS delegation name. NS, DS, and NSEC records at the delegation name are excluded because they are not shadowed by that delegation. Those record types are included only when they exist below the delegation. The value must be a non-apex subdomain of the zone. Requires |
| No; body and guard rules apply | string | Returns NS records that shadow the given name, searching at the name itself and each of its ancestor names within the zone, excluding the zone apex. The value must be a subdomain of the zone; the zone apex is not accepted. See Shadowed records. |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
get_dns_record
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
create_dns_record
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
update_dns_record
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
delete_dns_record
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
batch_dns_records
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See current schema minLength: |
| No; body and guard rules apply | boolean | Whether to include shadow metadata in the |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | object | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
batch_dns_records.payload
Argument | Required | Type | Details |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-delete. |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-patch. |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-post. |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-put. |
purge_cache
Argument | Required | Type | Details |
| No; body and guard rules apply | cache-purge_identifier | The zone ID. minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | Union | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
get_zone_setting
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier | See current schema minLength: |
| Yes | zones_setting_name | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
update_zone_setting
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier | See current schema minLength: |
| Yes | zones_setting_name | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | Union | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
update_zone_setting.payload.oneOf[0]
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_ssl_recommender_enabled | See the full input schema. |
update_zone_setting.payload.oneOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_setting_value | See the full input schema. |
list_workers
Argument | Required | Type | Details |
| No; body and guard rules apply | workers_identifier | See current schema minLength: |
| No; body and guard rules apply | string | Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'. |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
list_zone_rulesets
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | rulesets_Cursor | See current schema |
| No; body and guard rules apply | rulesets_PerPage | See current schema |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
get_zone_ruleset
Argument | Required | Type | Details |
| Yes | rulesets_RulesetId | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
get_zone_entrypoint
Argument | Required | Type | Details |
| Yes | rulesets_RulesetPhase | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
create_zone_ruleset
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | boolean | Validates the request without persisting changes when set to |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | JSON | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
create_zone_ruleset.payload.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_RulesetKind | See the full input schema. |
| No; body and guard rules apply | rulesets_RulesetPhase | See the full input schema. |
| No; body and guard rules apply | rulesets_RequestRules | See the full input schema. |
update_zone_ruleset
Argument | Required | Type | Details |
| Yes | rulesets_RulesetId | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | boolean | Validates the request without persisting changes when set to |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body and guard rules apply | JSON | Complete current native JSON request body. Do not mix with payload_file. |
| No; body and guard rules apply | string | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. minLength: |
delete_zone_ruleset
Argument | Required | Type | Details |
| Yes | rulesets_RulesetId | See current schema minLength: |
| No; body and guard rules apply | rulesets_ZoneId | See current schema minLength: |
| No; body and guard rules apply | boolean | Validates the request without persisting changes when set to |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
list_page_rules
Argument | Required | Type | Details |
| No; body and guard rules apply | zones_identifier-2 | See current schema minLength: |
| No; body and guard rules apply | string | The field used to sort returned Page Rules. Values: |
| No; body and guard rules apply | string | The direction used to sort returned Page Rules. Values: |
| No; body and guard rules apply | string | When set to |
| No; body and guard rules apply | string | The status of the Page Rule. Values: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
get_page_rule
Argument | Required | Type | Details |
| Yes | zones_identifier-2 | See current schema minLength: |
| No; body and guard rules apply | zones_identifier-2 | See current schema minLength: |
| No; body and guard rules apply | string | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. |
get_operation_schema
Argument | Required | Type | Details |
| Yes | string | See the full input schema. Values: |
preview_operation
Argument | Required | Type | Details |
| Yes | string | See the full input schema. Values: |
| Yes | object | See the full input schema. |
query_pages
Argument | Required | Type | Details |
| Yes | string | See the full input schema. Values: |
| Yes | object | See the full input schema. |
| No; body and guard rules apply | integer | See the full input schema. minimum: |
preview_dns_batch
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. minLength: |
| No; body and guard rules apply | string | See the full input schema. |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. minLength: |
preview_dns_batch.payload
Argument | Required | Type | Details |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-delete. |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-patch. |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-post. |
| No; body and guard rules apply | array | See the full input schema. Items: dns-records_dns-record-batch-put. |
apply_dns_batch
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. minLength: |
| No; body and guard rules apply | string | See the full input schema. |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. minLength: |
| Yes | string | See the full input schema. pattern: |
| No; body and guard rules apply | boolean | Set true only when the user asked for exactly this action. |
analytics_query
Argument | Required | Type | Details |
| Yes | string | See the full input schema. minLength: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
dns-records_AAAARecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A valid IPv6 address. format: |
| No; body and guard rules apply | boolean | Enables private network routing to the origin. default: |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_ARecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A valid IPv4 address. format: |
| No; body and guard rules apply | boolean | Enables private network routing to the origin. default: |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_CAARecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted CAA content. See 'data' to set CAA properties. |
| No; body and guard rules apply | object | Components of a CAA record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_CAARecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Flags for the CAA record. minimum: |
| No; body and guard rules apply | string | Name of the property controlled by this record (e.g.: issue, issuewild, iodef). |
| No; body and guard rules apply | string | Value of the record. This field's semantics depend on the chosen tag. |
dns-records_CERTRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted CERT content. See 'data' to set CERT properties. |
| No; body and guard rules apply | object | Components of a CERT record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_CERTRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Algorithm. minimum: |
| No; body and guard rules apply | string | Certificate. |
| No; body and guard rules apply | number | Key Tag. minimum: |
| No; body and guard rules apply | number | Type. minimum: |
dns-records_CNAMERecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A valid hostname. Must not match the record's name. |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_CNAMERecord.allOf[1].settings
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened. default: |
dns-records_DNSKEYRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted DNSKEY content. See 'data' to set DNSKEY properties. |
| No; body and guard rules apply | object | Components of a DNSKEY record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_DNSKEYRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Algorithm. minimum: |
| No; body and guard rules apply | number | Flags. minimum: |
| No; body and guard rules apply | number | Protocol. minimum: |
| No; body and guard rules apply | string | Public Key. |
dns-records_DSRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted DS content. See 'data' to set DS properties. |
| No; body and guard rules apply | object | Components of a DS record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_DSRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Algorithm. minimum: |
| No; body and guard rules apply | string | Digest. |
| No; body and guard rules apply | number | Digest Type. minimum: |
| No; body and guard rules apply | number | Key Tag. minimum: |
dns-records_HTTPSRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted HTTPS content. See 'data' to set HTTPS properties. |
| No; body and guard rules apply | object | Components of a HTTPS record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_HTTPSRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Priority. minimum: |
| No; body and guard rules apply | string | Target. |
| No; body and guard rules apply | string | Value. |
dns-records_LOCRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted LOC content. See 'data' to set LOC properties. |
| No; body and guard rules apply | object | Components of a LOC record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_LOCRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Altitude of location in meters. minimum: |
| No; body and guard rules apply | number | Degrees of latitude. minimum: |
| No; body and guard rules apply | string | Latitude direction. Values: |
| No; body and guard rules apply | number | Minutes of latitude. minimum: |
| No; body and guard rules apply | number | Seconds of latitude. minimum: |
| No; body and guard rules apply | number | Degrees of longitude. minimum: |
| No; body and guard rules apply | string | Longitude direction. Values: |
| No; body and guard rules apply | number | Minutes of longitude. minimum: |
| No; body and guard rules apply | number | Seconds of longitude. minimum: |
| No; body and guard rules apply | number | Horizontal precision of location. minimum: |
| No; body and guard rules apply | number | Vertical precision of location. minimum: |
| No; body and guard rules apply | number | Size of location in meters. minimum: |
dns-records_MXRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A valid mail server hostname. format: |
| No; body and guard rules apply | dns-records_priority | See the full input schema. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_NAPTRRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted NAPTR content. See 'data' to set NAPTR properties. |
| No; body and guard rules apply | object | Components of a NAPTR record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_NAPTRRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Flags. |
| No; body and guard rules apply | number | Order. minimum: |
| No; body and guard rules apply | number | Preference. minimum: |
| No; body and guard rules apply | string | Regex. |
| No; body and guard rules apply | string | Replacement. |
| No; body and guard rules apply | string | Service. |
dns-records_NSRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A valid name server host name. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_OPENPGPKEYRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1) |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_PTRRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Domain name pointing to the address. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_SMIMEARecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted SMIMEA content. See 'data' to set SMIMEA properties. |
| No; body and guard rules apply | object | Components of a SMIMEA record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_SMIMEARecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Certificate. |
| No; body and guard rules apply | number | Matching Type. minimum: |
| No; body and guard rules apply | number | Selector. minimum: |
| No; body and guard rules apply | number | Usage. minimum: |
dns-records_SRVRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Priority, weight, port, and SRV target. See 'data' for setting the individual component values. |
| No; body and guard rules apply | object | Components of a SRV record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_SRVRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | The port of the service. minimum: |
| No; body and guard rules apply | dns-records_priority | See the full input schema. |
| No; body and guard rules apply | string | A valid hostname. format: |
| No; body and guard rules apply | number | The record weight. minimum: |
dns-records_SSHFPRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted SSHFP content. See 'data' to set SSHFP properties. |
| No; body and guard rules apply | object | Components of a SSHFP record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_SSHFPRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Algorithm. minimum: |
| No; body and guard rules apply | string | Fingerprint. |
| No; body and guard rules apply | number | Type. minimum: |
dns-records_SVCBRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted SVCB content. See 'data' to set SVCB properties. |
| No; body and guard rules apply | object | Components of a SVCB record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_SVCBRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | number | Priority. minimum: |
| No; body and guard rules apply | string | Target. |
| No; body and guard rules apply | string | Value. |
dns-records_TLSARecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted TLSA content. See 'data' to set TLSA properties. |
| No; body and guard rules apply | object | Components of a TLSA record. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_TLSARecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Certificate. |
| No; body and guard rules apply | number | Matching Type. minimum: |
| No; body and guard rules apply | number | Selector. minimum: |
| No; body and guard rules apply | number | Usage. minimum: |
dns-records_TXTRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Text content for the record. The content must consist of quoted "character strings" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split. Learn more at . |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_URIRecord.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Formatted URI content. See 'data' to set URI properties. |
| No; body and guard rules apply | object | Components of a URI record. |
| No; body and guard rules apply | dns-records_priority | See the full input schema. |
| No; body and guard rules apply | string | Record type. Values: |
dns-records_URIRecord.allOf[1].data
Argument | Required | Type | Details |
| No; body and guard rules apply | string | The record content. |
| No; body and guard rules apply | number | The record weight. minimum: |
dns-records_dns-record-shared-fields
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_comment | See the full input schema. |
| No; body and guard rules apply | dns-records_name | See the full input schema. |
| No; body and guard rules apply | dns-records_proxied | See the full input schema. |
| No; body and guard rules apply | dns-records_settings | See the full input schema. |
| No; body and guard rules apply | dns-records_tags | See the full input schema. |
| No; body and guard rules apply | dns-records_ttl | See the full input schema. |
dns-records_settings
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6. default: |
| No; body and guard rules apply | boolean | When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6. default: |
dns-records_dns-record-batch-delete.allOf[0]
Argument | Required | Type | Details |
| No; body and guard rules apply | dns-records_identifier | See the full input schema. |
dns-records_dns-record-batch-patch
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See the full input schema. |
dns-records_dns-record-batch-put
Argument | Required | Type | Details |
| Yes | dns-records_identifier | See the full input schema. |
cache-purge_Everything
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Set to |
cache-purge_FlexPurgeByHostnames
Argument | Required | Type | Details |
| No; body and guard rules apply | array | Hostnames, such as |
cache-purge_FlexPurgeByPrefixes
Argument | Required | Type | Details |
| No; body and guard rules apply | array | URL prefixes, each a hostname followed by a path, such as |
cache-purge_FlexPurgeByTags
Argument | Required | Type | Details |
| No; body and guard rules apply | array | Cache tags. Targets all content whose |
cache-purge_SingleFile
Argument | Required | Type | Details |
| No; body and guard rules apply | array | Full URLs, such as |
cache-purge_SingleFileWithUrlAndHeaders
Argument | Required | Type | Details |
| No; body and guard rules apply | array | URLs with the request headers your cache key uses. Use this form when your cache key includes request headers, or the visitor's device type, country, or language: send the header values each URL was cached with, such as |
cache-purge_SingleFileWithUrlAndHeaders.files[]
Argument | Required | Type | Details |
| No; body and guard rules apply | object | Request headers and the values the content was cached with. |
| No; body and guard rules apply | string | Full URL of the content. |
zones_automatic_platform_optimization
Argument | Required | Type | Details |
| Yes | boolean | Indicates whether or not cache by device type is enabled. |
| Yes | boolean | Indicates whether or not Cloudflare proxy is enabled. default: |
| Yes | boolean | Indicates whether or not Automatic Platform Optimization is enabled. default: |
| Yes | array | An array of hostnames where Automatic Platform Optimization for WordPress is activated. Items: string. |
| Yes | boolean | Indicates whether or not site is powered by WordPress. default: |
| Yes | boolean | Indicates whether or not Cloudflare for WordPress plugin is installed. default: |
zones_cache-rules_aegis_value
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether the feature is enabled or not. |
| No; body and guard rules apply | string | Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin. |
zones_nel_value
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | See the full input schema. default: |
zones_security_header_value
Argument | Required | Type | Details |
| No; body and guard rules apply | object | Strict Transport Security. |
zones_security_header_value.strict_transport_security
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether or not strict transport security is enabled. |
| No; body and guard rules apply | boolean | Include all subdomains for strict transport security. |
| No; body and guard rules apply | number | Max age in seconds of the strict transport security. |
| No; body and guard rules apply | boolean | Whether or not to include 'X-Content-Type-Options: nosniff' header. |
| No; body and guard rules apply | boolean | Enable automatic preload of the HSTS configuration. |
rulesets_BlockRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_BlockRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | object | The response to show when the block is applied. |
rulesets_BlockRule.allOf[1].action_parameters.response
Argument | Required | Type | Details |
| Yes | string | The content to return. minLength: |
| Yes | string | The type of the content to return. minLength: |
| Yes | integer | The status code to return. minimum: |
rulesets_ChallengeRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_CompressResponseRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_CompressResponseRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| Yes | array | Custom order for compression algorithms. minItems: |
rulesets_CompressResponseRule.allOf[1].action_parameters.algorithms[]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | Name of the compression algorithm to enable. Values: |
rulesets_DDoSDynamicRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_ExecuteCategoryOverrides[]
Argument | Required | Type | Details |
| No; body and guard rules apply | JSON | See the full input schema. |
| Yes | JSON | See the full input schema. |
| No; body and guard rules apply | JSON | See the full input schema. |
| No; body and guard rules apply | JSON | See the full input schema. |
rulesets_ExecuteMatchedData
Argument | Required | Type | Details |
| Yes | string | The public key to encrypt matched data logs with. minLength: |
rulesets_ExecuteOverrides
Argument | Required | Type | Details |
| No; body and guard rules apply | JSON | See the full input schema. |
| No; body and guard rules apply | rulesets_ExecuteCategoryOverrides | See the full input schema. |
| No; body and guard rules apply | JSON | See the full input schema. |
| No; body and guard rules apply | rulesets_ExecuteRuleOverrides | See the full input schema. |
| No; body and guard rules apply | JSON | See the full input schema. |
rulesets_ExecuteRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_ExecuteRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| Yes | JSON | See the full input schema. |
| No; body and guard rules apply | rulesets_ExecuteMatchedData | See the full input schema. |
| No; body and guard rules apply | rulesets_ExecuteOverrides | See the full input schema. |
rulesets_ExecuteRuleOverrides[]
Argument | Required | Type | Details |
| No; body and guard rules apply | JSON | See the full input schema. |
| No; body and guard rules apply | JSON | See the full input schema. |
| Yes | JSON | See the full input schema. |
| No; body and guard rules apply | integer | The score threshold to use for the rule. |
| No; body and guard rules apply | JSON | See the full input schema. |
rulesets_ForceConnectionCloseRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_JsChallengeRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_LogCustomFieldCookieFields[]
Argument | Required | Type | Details |
| Yes | string | The name of the cookie. minLength: |
rulesets_LogCustomFieldRawResponseFields[]
Argument | Required | Type | Details |
| Yes | string | The name of the response header. minLength: |
| No; body and guard rules apply | boolean | Whether to log duplicate values of the same header. default: |
rulesets_LogCustomFieldRequestFields[]
Argument | Required | Type | Details |
| Yes | string | The name of the header. minLength: |
rulesets_LogCustomFieldResponseFields[]
Argument | Required | Type | Details |
| Yes | string | The name of the response header. minLength: |
| No; body and guard rules apply | boolean | Whether to log duplicate values of the same header. default: |
rulesets_LogCustomFieldRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_LogCustomFieldRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_LogCustomFieldCookieFields | See the full input schema. |
| No; body and guard rules apply | rulesets_LogCustomFieldRawResponseFields | See the full input schema. |
| No; body and guard rules apply | rulesets_LogCustomFieldRequestFields | See the full input schema. |
| No; body and guard rules apply | rulesets_LogCustomFieldResponseFields | See the full input schema. |
| No; body and guard rules apply | rulesets_LogCustomFieldTransformedRequestFields | See the full input schema. |
rulesets_LogCustomFieldTransformedRequestFields[]
Argument | Required | Type | Details |
| Yes | string | The name of the header. minLength: |
rulesets_LogRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_ManagedChallengeRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_RedirectFromList
Argument | Required | Type | Details |
| Yes | string | An expression that evaluates to the list lookup key. minLength: |
| Yes | string | The name of the list to match against. pattern: |
rulesets_RedirectFromValue
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to keep the query string of the original request. default: |
| No; body and guard rules apply | integer | The status code to use for the redirect. Values: |
| Yes | object | A URL to redirect the request to. |
rulesets_RedirectFromValue.target_url
Argument | Required | Type | Details |
| No; body and guard rules apply | string | An expression that evaluates to a URL to redirect the request to. minLength: |
| No; body and guard rules apply | string | A URL to redirect the request to. minLength: |
rulesets_RedirectRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_RedirectRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_RedirectFromList | See the full input schema. |
| No; body and guard rules apply | rulesets_RedirectFromValue | See the full input schema. |
rulesets_RewriteRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_RewriteRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_RewriteHeaders | See the full input schema. |
| No; body and guard rules apply | rulesets_RewriteUri | See the full input schema. |
rulesets_RewriteUri.allOf[0].anyOf[0]
Argument | Required | Type | Details |
| Yes | rulesets_RewriteUriPath | See the full input schema. |
rulesets_RewriteUri.allOf[0].anyOf[1]
Argument | Required | Type | Details |
| Yes | rulesets_RewriteUriQuery | See the full input schema. |
rulesets_RewriteUri.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to propagate the rewritten URI to origin. |
rulesets_RewriteUriPath
Argument | Required | Type | Details |
| No; body and guard rules apply | string | An expression that evaluates to a value to rewrite the URI path to. minLength: |
| No; body and guard rules apply | string | A value to rewrite the URI path to. minLength: |
rulesets_RewriteUriQuery
Argument | Required | Type | Details |
| No; body and guard rules apply | string | An expression that evaluates to a value to rewrite the URI query to. minLength: |
| No; body and guard rules apply | string | A value to rewrite the URI query to. |
rulesets_RouteOrigin
Argument | Required | Type | Details |
| No; body and guard rules apply | string | A resolved host to route to. minLength: |
| No; body and guard rules apply | integer | A destination port to route to. minimum: |
rulesets_RouteRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_RouteRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_RouteHostHeader | See the full input schema. |
| No; body and guard rules apply | rulesets_RouteOrigin | See the full input schema. |
| No; body and guard rules apply | rulesets_RouteSNI | See the full input schema. |
rulesets_RouteSNI
Argument | Required | Type | Details |
| Yes | string | A value to override the SNI to. minLength: |
rulesets_Rule
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_RuleAction | See the full input schema. |
| No; body and guard rules apply | object | The parameters configuring the rule's action. default: |
| No; body and guard rules apply | rulesets_RuleCategories | See the full input schema. |
| No; body and guard rules apply | string | An informative description of the rule. default: |
| No; body and guard rules apply | JSON | See the full input schema. |
| No; body and guard rules apply | rulesets_RuleExposedCredentialCheck | See the full input schema. |
| No; body and guard rules apply | string | The expression defining which traffic will match the rule. minLength: |
| No; body and guard rules apply | rulesets_RuleId | See the full input schema. |
| Yes | string | The timestamp of when the rule was last modified. format: |
| No; body and guard rules apply | rulesets_RuleLogging | See the full input schema. |
| No; body and guard rules apply | rulesets_RuleRatelimit | See the full input schema. |
| No; body and guard rules apply | string | The reference of the rule (the rule's ID by default). minLength: |
| Yes | string | The version of the rule. pattern: |
rulesets_RuleExposedCredentialCheck
Argument | Required | Type | Details |
| Yes | string | An expression that selects the password used in the credentials check. minLength: |
| Yes | string | An expression that selects the user ID used in the credentials check. minLength: |
rulesets_RuleLogging
Argument | Required | Type | Details |
| Yes | boolean | Whether to generate a log when the rule matches. |
rulesets_RuleRatelimit
Argument | Required | Type | Details |
| Yes | array | Characteristics of the request on which the rate limit counter will be incremented. minItems: |
| No; body and guard rules apply | string | An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression. minLength: |
| No; body and guard rules apply | integer | Period of time in seconds after which the action will be disabled following its first execution. |
| Yes | integer | Period in seconds over which the counter is being incremented. minimum: |
| No; body and guard rules apply | integer | The threshold of requests per period after which the action will be executed for the first time. minimum: |
| No; body and guard rules apply | boolean | Whether counting is only performed when an origin is reached. default: |
| No; body and guard rules apply | integer | The score threshold per period for which the action will be executed the first time. |
| No; body and guard rules apply | string | A response header name provided by the origin, which contains the score to increment rate limit counter with. minLength: |
rulesets_Ruleset
Argument | Required | Type | Details |
| No; body and guard rules apply | string | An informative description of the ruleset. default: |
| Yes | JSON | See the full input schema. |
| Yes | string | The timestamp of when the ruleset was last modified. format: |
| No; body and guard rules apply | string | The human-readable name of the ruleset. minLength: |
| Yes | JSON | See the full input schema. |
rulesets_ScoreRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_ScoreRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| Yes | rulesets_ScoreIncrement | See the full input schema. |
rulesets_ServeErrorRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | JSON | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_ServeErrorRule.allOf[1].action_parameters.allOf[0]
Argument | Required | Type | Details |
| Yes | rulesets_ServeErrorContentType | See the full input schema. |
| No; body and guard rules apply | rulesets_ServeErrorStatusCode | See the full input schema. |
rulesets_ServeErrorRule.allOf[1].action_parameters.allOf[1].oneOf[0]
Argument | Required | Type | Details |
| Yes | rulesets_ServeErrorContent | See the full input schema. |
rulesets_ServeErrorRule.allOf[1].action_parameters.allOf[1].oneOf[1]
Argument | Required | Type | Details |
| Yes | rulesets_ServeErrorAssetName | See the full input schema. |
rulesets_SetCacheControlDirective.oneOf[0]
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheControlCloudflareOnly | See the full input schema. |
| Yes | JSON | See the full input schema. |
rulesets_SetCacheControlDirective.oneOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheControlCloudflareOnly | See the full input schema. |
| Yes | JSON | See the full input schema. |
rulesets_SetCacheControlDirectiveWithQualifiers.oneOf[0]
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheControlCloudflareOnly | See the full input schema. |
| Yes | JSON | See the full input schema. |
| No; body and guard rules apply | array | Optional list of header names to qualify the directive (e.g., for "private" or "no-cache" directives). Items: string. |
rulesets_SetCacheControlDirectiveWithValue.oneOf[0]
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheControlCloudflareOnly | See the full input schema. |
| Yes | JSON | See the full input schema. |
| Yes | integer | The duration value in seconds for the directive. minimum: |
rulesets_SetCacheControlRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_SetCacheControlRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirectiveWithValue | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirectiveWithQualifiers | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirectiveWithQualifiers | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirective | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirectiveWithValue | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirectiveWithValue | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheControlDirectiveWithValue | See the full input schema. |
rulesets_SetCacheSettingsBrowserTTL
Argument | Required | Type | Details |
| No; body and guard rules apply | integer | The browser TTL (in seconds) if you choose the "override_origin" mode. minimum: |
| Yes | string | The browser TTL mode. Values: |
rulesets_SetCacheSettingsCacheKey
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to separate cached content based on the visitor's device type. |
| No; body and guard rules apply | boolean | Whether to protect from web cache deception attacks, while allowing static assets to be cached. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCustomCacheKey | See the full input schema. |
| No; body and guard rules apply | boolean | Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in. |
rulesets_SetCacheSettingsCacheReserve
Argument | Required | Type | Details |
| Yes | boolean | Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve. |
| No; body and guard rules apply | integer | The minimum file size eligible for storage in Cache Reserve. minimum: |
rulesets_SetCacheSettingsCustomCacheKey
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheSettingsCustomCacheKeyCookie | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCustomCacheKeyHeader | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCustomCacheKeyHost | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCustomCacheKeyQueryString | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCustomCacheKeyUser | See the full input schema. |
rulesets_SetCacheSettingsCustomCacheKeyCookie
Argument | Required | Type | Details |
| No; body and guard rules apply | array | A list of cookies to check for the presence of. The presence of these cookies is included in the cache key. minItems: |
| No; body and guard rules apply | array | A list of cookies to include in the cache key. minItems: |
rulesets_SetCacheSettingsCustomCacheKeyHeader
Argument | Required | Type | Details |
| No; body and guard rules apply | array | A list of headers to check for the presence of. The presence of these headers is included in the cache key. minItems: |
| No; body and guard rules apply | object | A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key. |
| No; body and guard rules apply | boolean | Whether to exclude the origin header in the cache key. |
| No; body and guard rules apply | array | A list of headers to include in the cache key. minItems: |
rulesets_SetCacheSettingsCustomCacheKeyHost
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to use the resolved host in the cache key. |
rulesets_SetCacheSettingsCustomCacheKeyQueryString
Argument | Required | Type | Details |
| No; body and guard rules apply | object | Which query string parameters to exclude from the cache key. |
| No; body and guard rules apply | object | Which query string parameters to include in the cache key. |
rulesets_SetCacheSettingsCustomCacheKeyQueryString.exclude
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to exclude all query string parameters from the cache key. Values: |
| No; body and guard rules apply | array | A list of query string parameters to exclude from the cache key. minItems: |
rulesets_SetCacheSettingsCustomCacheKeyQueryString.include
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to include all query string parameters in the cache key. Values: |
| No; body and guard rules apply | array | A list of query string parameters to include in the cache key. minItems: |
rulesets_SetCacheSettingsCustomCacheKeyUser
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to use the user agent's device type in the cache key. |
| No; body and guard rules apply | boolean | Whether to use the user agents's country in the cache key. |
| No; body and guard rules apply | boolean | Whether to use the user agent's language in the cache key. |
rulesets_SetCacheSettingsEdgeTTL
Argument | Required | Type | Details |
| No; body and guard rules apply | integer | The edge TTL (in seconds) if you choose the "override_origin" mode. minimum: |
| Yes | string | The edge TTL mode. Values: |
| No; body and guard rules apply | rulesets_SetCacheSettingsStatusCodeTTL | See the full input schema. |
rulesets_SetCacheSettingsOriginRangeRequests
Argument | Required | Type | Details |
| Yes | string | Whether to use range requests. |
rulesets_SetCacheSettingsRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_SetCacheSettingsRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheSettingsAdditionalCacheablePorts | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsBrowserTTL | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCache | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCacheKey | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsCacheReserve | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsEdgeTTL | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsOriginCacheControl | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsOriginErrorPagePassthru | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsOriginRangeRequests | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsReadTimeout | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsRespectStrongEtags | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsServeStale | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsSharedDictionary | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsStripETags | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsStripLastModified | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsStripSetCookie | See the full input schema. |
| No; body and guard rules apply | rulesets_SetCacheSettingsVary | See the full input schema. |
rulesets_SetCacheSettingsServeStale
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether Cloudflare should disable serving stale content while getting the latest content from the origin. |
rulesets_SetCacheSettingsSharedDictionary
Argument | Required | Type | Details |
| Yes | string | URL pattern for the Use-As-Dictionary match field. This pattern specifies which URLs can use this response as a dictionary. minLength: |
rulesets_SetCacheSettingsStatusCodeTTL[]
Argument | Required | Type | Details |
| No; body and guard rules apply | integer | A single status code to apply the TTL to. minimum: |
| No; body and guard rules apply | object | A range of status codes to apply the TTL to. |
| Yes | integer | The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value "no-cache". A value of -1 is equivalent to setting the cache control header with the value of "no-store". |
rulesets_SetCacheSettingsStatusCodeTTL[].status_code_range
Argument | Required | Type | Details |
| No; body and guard rules apply | integer | The lower bound of the range. minimum: |
| No; body and guard rules apply | integer | The upper bound of the range. minimum: |
rulesets_SetCacheSettingsVary
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SetCacheSettingsVaryDefault | See the full input schema. |
| No; body and guard rules apply | object | A mapping of lowercase request header names to their vary configuration. |
rulesets_SetCacheSettingsVaryDefault
Argument | Required | Type | Details |
| Yes | string | How the header value is treated when building the cache key. Values: |
rulesets_SetCacheSettingsVaryHeader
Argument | Required | Type | Details |
| Yes | string | How the header value is treated when building the cache key. Values: |
| No; body and guard rules apply | array | The set of languages to normalize against. Only valid for the |
| No; body and guard rules apply | array | The set of media types to normalize against. Only valid for the |
rulesets_SetCacheTagsRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | Union | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_SetCacheTagsRule.allOf[1].action_parameters.oneOf[0]
Argument | Required | Type | Details |
| Yes | JSON | See the full input schema. |
| Yes | rulesets_SetCacheTagsValues | See the full input schema. |
rulesets_SetCacheTagsRule.allOf[1].action_parameters.oneOf[1]
Argument | Required | Type | Details |
| Yes | rulesets_SetCacheTagsExpression | See the full input schema. |
| Yes | JSON | See the full input schema. |
rulesets_SetCacheTagsRule.allOf[1].action_parameters.oneOf[2]
Argument | Required | Type | Details |
| Yes | JSON | See the full input schema. |
| Yes | rulesets_SetCacheTagsValues | See the full input schema. |
rulesets_SetCacheTagsRule.allOf[1].action_parameters.oneOf[3]
Argument | Required | Type | Details |
| Yes | rulesets_SetCacheTagsExpression | See the full input schema. |
| Yes | JSON | See the full input schema. |
rulesets_SetCacheTagsRule.allOf[1].action_parameters.oneOf[4]
Argument | Required | Type | Details |
| Yes | JSON | See the full input schema. |
| Yes | rulesets_SetCacheTagsValues | See the full input schema. |
rulesets_SetCacheTagsRule.allOf[1].action_parameters.oneOf[5]
Argument | Required | Type | Details |
| Yes | rulesets_SetCacheTagsExpression | See the full input schema. |
| Yes | JSON | See the full input schema. |
rulesets_SetConfigAutominify
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to minify CSS files. default: |
| No; body and guard rules apply | boolean | Whether to minify HTML files. default: |
| No; body and guard rules apply | boolean | Whether to minify JavaScript files. default: |
rulesets_SetConfigRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_SetConfigRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | boolean | Whether to enable Automatic HTTPS Rewrites. |
| No; body and guard rules apply | rulesets_SetConfigAutominify | See the full input schema. |
| No; body and guard rules apply | boolean | Whether to enable Browser Integrity Check (BIC). |
| No; body and guard rules apply | boolean | Whether to enable content conversion (e.g., HTML to Markdown). |
| No; body and guard rules apply | boolean | Whether to disable Cloudflare Apps. Values: |
| No; body and guard rules apply | boolean | Whether to disable Pay Per Crawl. Values: |
| No; body and guard rules apply | boolean | Whether to disable Real User Monitoring (RUM). Values: |
| No; body and guard rules apply | boolean | Whether to disable Zaraz. Values: |
| No; body and guard rules apply | boolean | Whether to enable Email Obfuscation. |
| No; body and guard rules apply | boolean | Whether to enable Cloudflare Fonts. |
| No; body and guard rules apply | boolean | Whether to enable Hotlink Protection. |
| No; body and guard rules apply | boolean | Whether to enable Mirage. |
| No; body and guard rules apply | boolean | Whether to enable Opportunistic Encryption. |
| No; body and guard rules apply | string | The Polish level to configure. Values: |
| No; body and guard rules apply | boolean | Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response. |
| No; body and guard rules apply | string | The request body buffering mode. Values: |
| No; body and guard rules apply | string | The response body buffering mode. Values: |
| No; body and guard rules apply | boolean | Whether to enable Rocket Loader. |
| No; body and guard rules apply | string | The Security Level to configure. Values: |
| No; body and guard rules apply | boolean | Whether to enable Server-Side Excludes. |
| No; body and guard rules apply | string | The SSL level to configure. Values: |
| No; body and guard rules apply | boolean | Whether to enable Signed Exchanges (SXG). |
| No; body and guard rules apply | boolean | Whether to serve the WebMCP bridge script, which exposes the page's tools to browser AI agents. |
| No; body and guard rules apply | array | Bundled WebMCP tool packs to activate for matching requests. An empty array disables all packs. Omitting this parameter leaves the pack selection unchanged. Does not enable the WebMCP bridge itself. Non-empty selections require the WebMCP Configuration Rules entitlement. maxItems: |
rulesets_SkipRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_SkipRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| No; body and guard rules apply | rulesets_SkipPhase | See the full input schema. |
| No; body and guard rules apply | rulesets_SkipPhases | See the full input schema. |
| No; body and guard rules apply | rulesets_SkipProducts | See the full input schema. |
| No; body and guard rules apply | rulesets_SkipRules | See the full input schema. |
| No; body and guard rules apply | rulesets_SkipRuleset | See the full input schema. |
| No; body and guard rules apply | rulesets_SkipRulesets | See the full input schema. |
rulesets_TransformResponseHTMLRule.allOf[1]
Argument | Required | Type | Details |
| No; body and guard rules apply | string | See the full input schema. Values: |
| No; body and guard rules apply | object | See the full input schema. |
| No; body and guard rules apply | string | See the full input schema. |
rulesets_TransformResponseHTMLRule.allOf[1].action_parameters
Argument | Required | Type | Details |
| Yes | object | Enables the link maze transformation on the response. |
9. DNS, Rulesets, cache and analytics
A deliberate DNS change
Read list_zones, get_zone and list_dns_records to establish the exact zone and record. Inspect get_operation_schema for create_dns_record or update_dns_record. A PATCH edits provided fields; a PUT replacement can alter omitted-field behavior. Choose ttl/proxied/type/content deliberately rather than assuming every record should be proxied. DNS conflicts, plan constraints and semantic validity are finally decided by Cloudflare.
cloudflare-cli preview-operation --operation create_dns_record --arguments '{"zone_id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","payload":{"name":"review.example.com","type":"A","content":"192.0.2.1","ttl":1,"proxied":false}}' --agent
cloudflare-cli create-dns-record --zone-id YOUR_ZONE_ID --payload-file /absolute/private/approved-dns.json --account work --confirm --agentThe first command is a local illustration using documentation-only IDs/IPs. It makes no provider request. The second is a real mutation only when private credentials, a real resource and the explicitly approved body are supplied. After any approved change, read the returned record and check the intended resolver/service.
Review a small DNS batch
Save only the chosen native deletes/patches/puts/posts body in a private JSON file. preview_dns_batch validates the same native schema and 1–50 total-action cap, then returns a SHA-256 digest of method, exact zone path, profile label and canonically sorted JSON object keys. Array order is preserved. Read and approve the full body, target and profile before apply_dns_batch.
cloudflare-cli preview-dns-batch --zone-id YOUR_ZONE_ID --payload-file /absolute/private/approved-dns-batch.json --account work --agent
cloudflare-cli apply-dns-batch --zone-id YOUR_ZONE_ID --payload-file /absolute/private/approved-dns-batch.json --account work --preview-sha256 REVIEWED_64_CHARACTER_HASH --confirm --agentAny change to that reviewed request requires a new preview. This does not detect concurrent remote edits, credential rotation under the same label or changes in token grants. The digest is not an authorization secret, human approval signature or remote-state transaction lock. The direct native batch_dns_records command also exists, requires --confirm and does not require a digest; choose the review/apply workflow when you need exact local review.
Cloudflare batch semantics execute deletes, patches, puts, then posts in a database transaction; distributed DNS propagation remains non-atomic. If provider validation fails, no batch changes apply. A network failure after submission can leave the outcome unknown; read the affected records before repeating. The wrapper never promises all resolvers change at once or supplies a rollback.
Settings and Rulesets
get_zone_setting with setting_id=ssl replaces the older SSL helper. Inspect the setting's editable/value metadata before update_zone_setting. Ruleset actions and phases have distinct plan/grant requirements; read list_zone_rulesets, get_zone_ruleset and get_zone_entrypoint before creation/update/deletion. Source schemas are broad and cannot establish that a chosen expression or action is appropriate. This release has no deprecated firewall-rule writer and no misleading Page Rule redirect shortcut.
Page Rules are readable for migration inventory; no Page Rules writer is exposed. A redirect should use a consciously selected modern Ruleset phase/action and full approved body. Cloudflare's modern Rules product is not a drop-in rename of every old rule.
Cache, Workers and analytics
purge_cache changes edge cache only for the specified native request; it requires confirmation even for a single URL. It does not delete source files. list_workers reads script metadata, not script content, secrets or deployment state. Use Wrangler/cf for deployment workflows.
analytics_query accepts exactly one parsed GraphQL query with variables, refusing mutation/subscription/multiple-operation/schema documents. It is not a compiled dataset client or automatic time-series export. Choose eligible zoneTag/accountTag, dataset, time window, limits and ordering using current analytics docs/settings discovery. Provider partial errors fail instead of becoming silent success. Sampling, retention and dataset permissions still apply.
10. Pagination, retries and local input files
Ordinary reads fetch one provider response. query_pages supports only list_provider_accounts, list_zones and list_dns_records, with explicit native arguments, max_pages=1–5 and a local per_page cap of 100. Positive page numbers are required. result_info total_pages/total_count controls continuation. Missing metadata stops after the current response and reports continuationUnknown=true, rather than guessing complete. pages preserves native envelopes; pagesRead/hasMore/resumePage make the bounded result explicit.
cloudflare-cli query-pages --operation list_dns_records --arguments '{"zone_id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","per_page":50,"page":1}' --max-pages 2 --agentNo automatic replay occurs after HTTP 429, transient error, timeout or mutation failure. Every ordinary native operation submits one request; bounded reads can submit up to the selected page budget. Parallel processes/profile labels share provider limits when they use the same token. A timeout is not proof that a mutation failed.
payload_file must be a regular non-symlink JSON file, at most 1 MiB; native payload and payload_file cannot be mixed. Confirmation/read-only policies are checked before file loading or provider fetch for mutations. The request body is validated through current Ajv schemas. This wrapper does not execute file content, upload local media, load .env automatically or accept arbitrary provider hosts/headers. Treat inputs and returned DNS TXT/rule descriptions as data, never agent instructions.
11. Several private accounts
Private profile configuration prevents implicit credential inheritance between named accounts. Configure the following placeholders only in a private client environment:
[
{
"name": "work",
"token_file": "/absolute/private/work-cloudflare.txt",
"account_id": "YOUR_WORK_ACCOUNT_ID",
"zone_id": "YOUR_WORK_ZONE_ID",
"token_kind": "user"
},
{
"name": "client",
"token_file": "/absolute/private/client-cloudflare.txt",
"account_id": "YOUR_CLIENT_ACCOUNT_ID",
"zone_id": "YOUR_CLIENT_ZONE_ID",
"token_kind": "account"
}
]Put the array in CLOUDFLARE_ACCOUNTS and set CLOUDFLARE_DEFAULT_ACCOUNT=work. Names must be unique and nonempty. --account selects the exact label; list_accounts returns only label/default/auth method, never token values, file paths or provider IDs. A profile lacking credentials does not fall back to a global token. Global account/zone defaults likewise do not leak into explicitly named entries.
account_id/zone_id are routing defaults; explicit operation inputs take precedence and can name another resource allowed by the token. Token-kind defaults to user and only changes the diagnostic verification route. Use provider token resource scopes for real access boundaries. Local profile separation is not a multi-user access-control service.
12. Writing safely
Every one of the eleven mutations requires confirm=true in MCP or --confirm in the CLI. The same write guard runs before file loading/provider execution. Creation, edits, replacement, deletion, cache purge and Ruleset changes all require explicit intent. --agent and --yes never grant it.
Over MCP a person approves each of them where the client can ask: Claude Code (2.1.246 and later) shows its own prompt, and a client that can show forms asks with an approval form whose one box starts unticked. Each approval is signed, bound to that exact call and works once. Where a client can do neither, the model's confirm:true counts. CLOUDFLARE_CONFIRM=model makes confirm:true enough everywhere, for an agent with no person to ask.
CLOUDFLARE_READ_ONLY=1 hides every mutation and refuses direct calls to hidden names even with confirmation. CLOUDFLARE_ALLOW_DESTRUCTIVE=0 blocks all mutations even when confirmed; read-only takes precedence. Use narrow provider tokens as the authorization boundary. A model can assert confirm=true; where the client can ask, the person approves instead, and that approval is signed and bound to the exact call. Where it cannot, confirm=true is the model's assertion, not a person's approval.
Review the exact zone/account, profile, record/rule IDs and full native body. apply_dns_batch additionally compares the reviewed request digest and makes one native request without automatic replay. Local preview does not authenticate the account, check conflicts or read remote state. Direct native batch also needs confirmation but does not require the digest.
An optional CLOUDFLARE_AUDIT_LOG records timestamp, surface, tool, risk, static summary, decision and who approved it, then a done or failed line for each allowed call. It excludes request bodies, account IDs and tokens. Existing file ACLs/rotation are your responsibility; a failed audit append does not block the action. Account data returned after a change is untrusted content.
13. How the two surfaces work
src/tools/index.ts builds one ALL_TOOLS catalogue from reviewed operation metadata and seven helpers. Slipway builds both binaries from it: the MCP server, over stdio or --http, and the CLI, with the same schemas, validation, profile routing, API client and write guard. CLI command names are the tool names with hyphens.
The server can initialize/discover without credentials. Local helper annotations accurately distinguish local work from provider calls. API requests use one fixed origin, no arbitrary headers or redirects and no automatic retries. Current selected body schemas use Ajv with formats; analytics is parsed through GraphQL's AST before fetch. Version comes from package.json; the desktop manifest/root lock must agree.
The public metadata excludes vendor examples/code samples. scripts/sync-openapi.mjs checks distributed metadata offline or compares against a checksum-reviewed local official JSON file. Refresh requires an explicit reviewed checksum and source commit; it has no network or source-code import path. Review changes, scan, rebuild, regenerate docs and bump versions before release.
14. Privacy and data handling
Account commands send the selected token in a Bearer header only to api.cloudflare.com. Prompts are not forwarded by this package; the native request/query content you select is. Your AI client may send returned DNS records, rule expressions and analytics to its model provider according to its own policy. The wrapper has no telemetry, public HTTP listener or hosted account store.
Named private profiles do not inherit global credentials. Token files use size/type/POSIX owner-only checks and are cached until restart. Windows ACLs require separate user configuration. Never commit credentials, .env, token files, real account exports or signed URLs; keep all such files outside public source and release staging.
Known credential keys, configured secrets and recognized signed URLs are redacted from ordinary output/errors. Legitimate URLs are preserved. Redaction is not complete anonymization: DNS TXT records, names, expressions and returned account data may still be sensitive. --select is local data shaping, not an authorization boundary or upstream privacy filter. Capture only needed output; terminal history and client transcripts can persist it.
Optional audit logging stores policy metadata, not bodies. The package does not automatically persist provider responses or backups; private input/output files you create remain on your system until you manage them. Revoke tokens through Cloudflare, not npm.
15. Environment variables
Configure these privately in the environment of the actual client process. The package does not automatically load a .env file. GUI clients may need private settings rather than shell exports.
Variable | Purpose / default |
| Private Bearer API token; no Global API Key support |
| Absolute regular owner-only token-only file; max 64 KiB; takes precedence |
| Private JSON array of explicit named profiles; no global credential/default inheritance |
| Exact profile name; first profile default when omitted |
| Optional default account ID when using the single global profile |
| Optional default zone ID when using the single global profile |
| user (default) or account; doctor verification route only |
| 1/true hides/refuses every mutation |
| 0/false refuses confirmed mutations; otherwise enabled |
| Optional private append-only metadata path |
| Default 30000; integer 100–300000; no automatic retry |
| Default 200; integer 0–10000; per profile/process |
|
|
|
|
| Give up on any tool after this long |
| For |
| Comma-separated browser origins allowed to call |
|
|
Credential/profile fields are strings without line breaks. Only 1/true enables read-only; 0/false disables destructive operations. Named profile keys are name, api_key or api_token, token_file, account_id, zone_id and token_kind. api_key is a compatibility field name holding a Bearer token, never a Global API Key.
16. Updates and removal
npm install -g @thenavidm/cloudflare-mcp-cli@latest
cloudflare-cli --version
npm uninstall -g @thenavidm/cloudflare-mcp-cli
codex mcp remove cloudflarenpx @latest resolves again when the server starts; restart/reconnect to use the release. Global npm installs need an explicit update. Desktop extensions need the new versioned archive installed separately. Check CHANGELOG.md and the manifest; remove duplicate MCP entries rather than running two account servers accidentally.
Remove client configuration/skill references and deliberately manage private files. Uninstall does not revoke tokens or undo DNS, Rulesets/cache changes. Existing private legacy refs stay private; migrate configuration/commands deliberately using the map below. Pin 2.0.0 if reproducible installation matters more than automatically receiving the latest release.
17. Troubleshooting
Symptom | Check |
Binary missing / PowerShell policy | Node/npm version, npm global prefix/PATH, npm.cmd or Command Prompt; reopen terminal |
GUI cannot launch npx | Client environment; Windows cmd /c launcher or absolute node and entry path |
Exit 10 | Private token/file for the selected profile; no implicit global inheritance |
Token doctor fails | Token kind, account ID for account-owned verification, expiry/IP filter and active status |
Token verifies but zone read fails | Exact resource IDs, token permissions/resource restrictions and membership |
Mutation refuses | Exact --confirm/confirm:true, read-only and disabled-operation policy |
Native body rejected | Complete current JSON payload, type-specific union branch, required keys and no unknown root fields |
Batch digest changed | Re-preview exact zone/profile/body; do not copy a digest from another request |
Unknown continuation | Provider metadata absent; bounded result does not establish the entire library |
HTTP 200 but command fails | Provider success/errors or GraphQL partial errors; inspect sanitized error |
HTTP 429 / timeout | Provider quota/reset; no automatic replay; inspect state before deliberate retry |
Setting/rule unsupported | Provider plan, editable state, selected Ruleset phase/action and accepted grants |
Analytics absent / sampled | Dataset settings, time window, plan/grant/retention and sampling |
Expected Worker deploy / OAuth | Use official cf/Wrangler or hosted MCP; this focused package has neither |
Report a minimal redacted reproduction with package/client/OS versions and tool name. Never post token values, real DNS TXT secrets, private bodies or full account exports. Account/GUI/task outcomes are not established by fixture tests or stdio discovery.
18. API coverage and comparisons
Offering | Current surface | Verified strengths and limits |
https://mcp.cloudflare.com/mcp; current pinned README lists docs/search/execute | OAuth or user/account token access, sandboxed code execution across the wider API, provider-maintained documentation search and configurable truncation. Individual endpoint tools are optional. Client approval and token permission boundaries remain relevant. | |
cf 1.0.0-beta.12; Cloudflare documents more than 2900 commands | General account API coverage, command search, schemas, JSON, dry-run, named profiles, OAuth refresh, resource name resolution and local developer resources. Delete confirmation already exists. | |
4.147.0 at this review | Workers development/deployment and related project workflows. This focused package does not replace the developer toolchain. | |
Provider-hosted service-specific MCP endpoints | Specialized analytics, builds, browser rendering and other products; current /mcp endpoints use Streamable HTTP. These are distinct from a local stdio DNS task wrapper. | |
Community MIT source 1.0.0; 11 documented tools; stdio/HTTP | DNS convenience, BIND export, edit snapshots, guarded raw passthrough and optional Worker deployment/secrets. Delete/passthrough confirmation is already present. No dedicated task CLI is declared in the pinned package. | |
This owned package | 29 shared local MCP tools / CLI commands; versioned desktop bundle | 18 reads and 11 mandatory-confirmation mutations, isolated private profiles, complete selected native schemas, local previews, bounded page reads, reviewed DNS digest and no automatic replay. Narrower coverage than the official general API tools. |
Checked October 3, 2026. Official MCP source: cloudflare/mcp commit 69ba3143bb8ffa2b3c1f12bfb7536c9ca4c57a2d. Selected API schema: cloudflare/api-schemas commit 37e7a4ae9c5123a2c58929a100c42cb4584edc57, API info 4.0.0. Community source is pinned above; its extra workflows are useful and are not claimed here.
The actual public cf@1.0.0-beta.12 package installed cleanly. Its complete binary passed version, command search, DNS-create schema and DNS-create dry-run checks with inherited provider credentials removed, telemetry disabled and fetch blocked. Its published DNS-create handler plus run wrapper were separately exercised in an isolated function fixture: a valid create without a confirmation flag reached an injected network-free SDK request once; dry-run reached it zero times. That fixture is not an authenticated Cloudflare operation or a whole-client approval test. Our equivalent shared handler refuses before fetch without explicit confirmation, including direct MCP calls.
Official cf already confirms deletes and has useful dry-run/profile features. Code Mode isolates credential injection from generated code; do not describe it as handing account tokens to the model. Reviewed official retry code can replay requests on transient/429 failures; this wrapper does not replay any request automatically. Confirmation is the caller asserting approved intent, not a cryptographic proof of a human approval or provider authorization.
The owned use case is a focused, repeatable DNS/zone task with consistent approval across CLI and MCP and an exact-request batch review. Choose official cf/Code Mode for broader API work and Wrangler for deployments. SEO, more tool names and metadata size do not establish better tasks or lower token cost. Live provider outcomes, GUI installation and actual matched Codex usage remain separately unverified.
Legacy command migration
Legacy command | Current route | Migration detail |
list_zones/get_zone | Same names | Current native arguments/envelopes; use exact filters |
list_dns_records/create/update/delete | Same names | Complete native payload schemas; every mutation confirmed |
purge_cache | Same name | Native body and explicit approval |
get_ssl_settings/update_ssl_settings | get_zone_setting/update_zone_setting | setting_id=ssl and current value schema |
get_zone_settings/update_zone_setting | Per-setting read/update | Deprecated bulk settings route excluded |
get_zone_analytics | analytics_query | Read-only current GraphQL dataset query, not deprecated REST dashboard |
list_firewall_rules | list_zone_rulesets / get_zone_ruleset | Current Rulesets product; no deprecated firewall writer |
create_redirect_rule/list_redirects | Explicit selected Ruleset workflow | Legacy helper created Page Rules; modern redirect phase/action must be reviewed |
list_page_rules | Read-only Page Rules inventory | No legacy Page Rule writer |
list_workers | Same name | Worker script metadata only, no deployment |
Private legacy source is retained separately and never pushed into clean public history. The old source has 17 MCP tools and no declared task CLI. This release changes input/response/config contracts, so migration is deliberate rather than an unverified drop-in compatibility promise.
19. Versions
Component | Reviewed version / source |
Owned package / desktop | 3.0.1 |
Legacy source package | 1.0.0; private source b6fef82d992cefbfb4ea9a9ea49e17275609c34e |
Cloudflare REST API schema | API info 4.0.0; commit 37e7a4ae9c5123a2c58929a100c42cb4584edc57 |
Official cf / Wrangler | 1.0.0-beta.12 / 4.147.0 at review |
@thenavidm/slipway | 0.1.17 |
MCP TypeScript SDK, through Slipway | 2.3.0 |
ajv | 8.20.0 |
ajv-formats | 3.0.1 |
graphql | 16.14.2 |
typescript | 7.0.2 |
vitest | 5.0.3 |
vite | 8.3.2 |
@anthropic-ai/mcpb | 2.1.2 |
See CHANGELOG.md for dated changes and GitHub Releases for annotated source tags and versioned desktop assets. Match npm, server, manifest and root lock versions. Future schema refreshes must record upstream commit/checksums, exclusions, changed inputs and comparison evidence; do not assume a provider beta stays the same. No prior public legacy npm/tag release is implied.
20. FAQ
A focused shared Cloudflare CLI/local MCP and desktop archive, with 29 tools: 18 reads and 11 explicitly confirmed mutations. Its selected DNS/zone management surface is narrower than the official general API tools.
Yes. Code Mode MCP, specialized provider MCPs, the general cf CLI and Wrangler already exist. The comparison documents their strengths and our specific recurring workflow rather than claiming they are missing.
For consistent mandatory confirmation in both local surfaces, isolated private profiles and an exact-request DNS batch review. These are tested local workflow differences; no universal superiority or measured token winner is claimed.
Yes: register the npx @latest stdio command, forward private environment settings, or use cloudflare-cli with SKILL.md. Discovery works without provider authentication; account operations need the intended token grant.
A versioned .mcpb vendors production dependencies and exposes private token/file/default/policy settings. Manual stdio is also documented. A protocol handshake is not a verified desktop GUI installation.
The house setup covers Node 22+ on macOS, Windows and Linux and local stdio clients including Codex, Claude, Cursor, VS Code, Windsurf, Zed, Gemini CLI and Cline. Client runtime, policy and launchers still matter; remote-only clients use official hosted MCP.
No. This Bearer-only wrapper expects a least-privilege API token. Restrict its Cloudflare permissions/resources; local profile defaults do not narrow upstream grants.
Yes when the intended endpoints support that token type. Set token_kind=account and an account ID for doctor verification. Token kind changes only the diagnostic route; provider compatibility and permissions remain authoritative.
No. login prints private token instructions. The package neither opens consent nor reads/renews official cf OAuth sessions or global CLI configuration.
Set CLOUDFLARE_READ_ONLY=1 and reconnect. Eleven mutations disappear and direct calls still refuse. CLOUDFLARE_ALLOW_DESTRUCTIVE=0 additionally refuses confirmed mutations.
No. Every mutation needs --confirm or confirm:true for the actual requested operation. The client/human still determine that it was approved; this flag is not a signed human consent.
The exact method, zone path, profile label and canonical native JSON body, preserving array order. Any change requires a new local preview. It does not bind remote state or a token grant and does not prevent concurrent edits.
The review/apply helper does. Direct native batch_dns_records also exists, requires explicit confirmation and follows the native schema/provider limits, but does not require a digest.
No. Cloudflare executes the request in a database transaction but distributed propagation is not atomic. Inspect affected records after an unknown outcome and do not automatically repeat submissions.
No. Ordinary commands fetch one response. query_pages supports three named reads with a one-to-five-page budget and explicit continuation/unknown reporting.
No request retries automatically. Wait for current upstream reset policy, inspect possible mutation state and deliberately repeat only if appropriate.
No. list_workers is metadata only. Use official cf, Code Mode or Wrangler for broader/deployment tasks. There is no unrestricted raw request tool here.
One parsed GraphQL query at a time, with variables and provider-controlled dataset permissions, retention, sampling and limits. It refuses mutations and partial-error responses; it is not an automatic analytics export.
It depends on the client and the task. In Claude Code the CLI costs nothing until it is used, plus about 4,000 tokens for SKILL.md once, where the server costs about 610 tokens a message with tool search and 144,000 with every tool loaded. In Codex, finding the command that purges a zone's cache took a median of 83,426 input tokens over the CLI and 41,139 over MCP. Section 7 has how each was measured.
Restart npx @latest, explicitly update global npm installs and reinstall new desktop archives separately. Remove client entries and revoke the intended token through Cloudflare. Uninstall does not undo provider changes.
Questions
Open a sanitized issue. Read SECURITY.md for private reports.
About the author
Navid Moazzez is a leading AI business strategist, and the host of the AI Creator Summit, watched by 100,000+ creators. He helps creators and founders master AI and build their own AI Operating System (AI OS) to automate their business and life. He creates useful free tools, MCP servers and CLIs that creators and founders can use in their own workflows.
Links
Personal website: navid.me
Link in bio: navid.bio
Navid Media: navid.media
YouTube: @thenavidm and @thenavidai
X: @thenavidm
Instagram: @thenavidm
LinkedIn: thenavidm
If this is useful, star the repo and come say hi on X.
Dependencies
Runtime: Slipway, which brings the MCP TypeScript SDK, plus Ajv, ajv-formats and GraphQL. Development: TypeScript, Vitest, Vite and MCPB. Exact component versions are above and in package-lock.json. Reviewed Cloudflare API schema metadata is BSD-3-Clause and credited in THIRD_PARTY_NOTICES.md; packaging development tools are excluded from runtime bundles.
License
Preserves AGPL-3.0-or-later. Read LICENSE, the full text and THIRD_PARTY_NOTICES.md. Cloudflare terms and trademarks remain separate.
© 2026 Navid Media. Made with ❤️ by Navid Moazzez.
Available Tools
29 toolsanalytics_queryRead GraphQL analyticsBRead-onlyIdempotent
One parsed GraphQL query only, with variables. No mutations, subscriptions or multiple operations. Permissions, dataset retention, sampling and query limits remain provider controlled.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| account | No | ||
| variables | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, openWorld and non-destructive, but the description adds genuinely new behavioral context: only one operation per call and that permissions, retention, sampling and query limits are governed by the provider rather than the caller. That is useful, non-duplicative information about limits and execution semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences, front-loaded with the single most important constraint (one parsed operation with variables). Every sentence carries weight; nothing is padded or restated.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description should at least hint at return shape, pagination or error behavior for an open-world analytics query, and it does not. It covers the core constraint and provider-controlled limits adequately, but an agent still lacks enough to predict results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% across 3 parameters (query, account, variables), so the description must compensate. It names 'variables' and constrains the query implicitly (single operation), but says nothing about the `account` parameter or the expected query string format, leaving most parameter meaning undocumented.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The name/title establish reading GraphQL analytics and the description pins the resource further: exactly one parsed GraphQL operation, optionally with variables. It is clearly distinguishable from every sibling (all DNS/zone/ruleset tools), though the description never states the verb 'execute/run' explicitly, relying on the title to carry that.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It supplies real exclusions — no mutations, subscriptions or multiple operations — which implies the intended read-only single-operation use case. It offers no explicit when-to-use framing or alternative routing, though no sibling competes for this purpose, so the gap is small.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
apply_dns_batchApply reviewed DNS batchADestructive
Verify the reviewed digest and submit one exact native DNS batch with mandatory confirmation. Does not assert remote-state consistency or atomic DNS propagation; no retry.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | ||
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | ||
| zone_id | No | ||
| payload_file | No | ||
| preview_sha256 | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructive=true, idempotent=false and openWorld=true, so the safety profile is covered. The description adds genuinely non-obvious behavioral caveats beyond that: no remote-state consistency assertion, no atomic propagation guarantee, and no retry. These are exactly the operational risks an agent needs before firing a destructive batch.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action and precondition, followed by the caveats. Every clause carries information and nothing is redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, non-idempotent batch write with nested record payloads and no output schema, the description covers confirmation and digest verification but omits how the batch content is supplied (payload object vs payload_file), zone/account targeting, and the partial-failure semantics of a mixed put/post/patch/delete batch. Adequate but with clear gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 17% across 6 parameters. The description touches 'confirm' (mandatory confirmation) and 'preview_sha256' (reviewed digest), but says nothing about payload vs payload_file, zone_id, or account, and gives no guidance on the puts/posts/patches/deletes batch structure. With low coverage the description is expected to compensate and largely does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('submit one exact native DNS batch') plus a precondition ('verify the reviewed digest'), so an agent understands this is the execution step of a preview-then-apply flow. It does not name the sibling it pairs with (preview_dns_batch) or distinguish itself from batch_dns_records, but the purpose is unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'Verify the reviewed digest' and 'mandatory confirmation' imply the required upstream workflow (preview first, then confirm), which is useful implied context. However, no alternative tool is named and no when-not-to-use condition is given, so the routing guidance remains implicit rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
batch_dns_recordsBatch DNS RecordsBDestructive
Send a Batch of DNS Record API calls to be executed together.
Notes:
Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare's distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See the documentation for more information.
The operations you specify within the /batch request body are always executed in the following order:
Deletes
Patches
Puts
Posts Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. | |
| include_shadow_metadata | No | Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false and readOnlyHint=false, but the description adds real behavior beyond them: non-atomic propagation via the distributed KV store, and the deterministic execution order (deletes, patches, puts, posts). The warning not to auto-repeat an unknown outcome reinforces the non-idempotent hint with actionable caution. It stops short of describing the response or failure/rollback semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in one sentence, and the following notes are compact and additive rather than repetitive. The execution-order list earns its place because it materially affects how the payload must be composed, though the odd indentation adds minor noise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, nested-object, no-output-schema tool, the description covers the critical atomicity and ordering hazards well. However it omits return-value expectations and any routing context relative to preview_dns_batch/apply_dns_batch, leaving gaps an agent would need to resolve elsewhere.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 83%, so the schema already documents account, confirm, payload/payload_file, zone_id and include_shadow_metadata, giving a baseline of 3. The description adds nothing about any parameter, so it does not earn above baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening sentence names a specific verb and resource: batching DNS Record API calls into a single request, executed together. It is clear on its own, but it never distinguishes itself from close siblings like preview_dns_batch or apply_dns_batch, which an agent would need to choose between.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use or when-not-to-use guidance, and no mention of the obvious alternative preview_dns_batch for dry-running a batch. The only usage constraint offered is the confirmation note ('Every change requires explicit confirmation'), which is a safety rule rather than routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_dns_recordCreate DNS RecordADestructive
Create a new DNS record for a zone.
Notes:
A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. | |
| include_shadow_metadata | No | Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, but the description adds real value beyond them: DNS conflict invariants (A/AAAA cannot coexist with CNAME; NS cannot coexist with any other type), Punycode normalization of domain names, and the confirmation/no-auto-retry expectation. It doesn't describe the return payload or failure modes, keeping it below a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action, then three tightly scoped bullets on real edge cases, with the confirmation directive last. The final sentence is slightly tacked on and mixes operational policy with the record semantics, but overall there is little waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, non-idempotent mutation with no output schema, the description covers conflict rules, name encoding, and the confirmation requirement, which is most of what an agent needs before calling. It omits what the call returns and how it interacts with the sibling update/overwrite tools, leaving a small gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 83%, so the schema already documents zone_id, payload, confirm, account, payload_file and the record variants. The description adds no parameter-level semantics of its own, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Create a new DNS record for a zone.' That is unambiguous and lets an agent distinguish it from delete/update/overwrite siblings by connotation, though no sibling is named explicitly. Clear purpose, but no explicit differentiation among the create-family tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is partly covered by the closing line 'Every change requires explicit confirmation; never repeat an unknown outcome automatically,' which tells the agent to obtain confirmation before acting. However, it never says when to use create_dns_record versus overwrite_dns_record, update_dns_record, or batch_dns_records, leaving the main routing decision implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_zone_rulesetCreate a zone rulesetBDestructive
Creates a ruleset at the zone level. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| dry_run | No | Validates the request without persisting changes when set to `true`. Responses that normally return 200 return `result: null`; endpoints that normally return 204 continue to return 204. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds a meaningful behavioral rule about mandatory confirmation and not auto-repeating an unknown outcome, but says nothing about what state is affected or what entitlements exist.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with the core action front-loaded and no wasted verbiage. It is efficient, though the second sentence is a behavioral note rather than tool-selection help.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a deeply nested, non-idempotent zone mutation with a very large payload schema, the description is thin: it omits the confirm/dry_run workflow and the required ruleset fields (name, kind, phase). Annotations cover the safety side, but the agent gains little from the description about correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 83%, so the schema already documents account, confirm, dry_run, payload, and payload_file. The description adds no parameter-level detail such as how payload and payload_file interact or when to use dry_run, so it does not exceed the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Creates a ruleset') plus the scope ('at the zone level'). It is distinguishable from delete_zone_ruleset and list_zone_rulesets, though it does not explicitly contrast with update_zone_ruleset, which is the closest sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The second sentence gives operational guidance ('requires explicit confirmation; never repeat an unknown outcome automatically'), which implies caution around retries, but it never names an alternative tool or states when to prefer create vs update. Usage must be inferred.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_dns_recordDelete DNS RecordADestructive
Permanently removes a DNS record from the zone. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| zone_id | No | ||
| dns_record_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false. The description adds valuable operational context beyond annotations: deletion is permanent, explicit confirmation is required, and unknown outcomes should not be retried automatically.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action and followed by the key operational constraint. Every sentence earns its place with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Annotations carry the safety profile and the schema marks dns_record_id as required, but the description omits which parameters are required and does not clarify zone/account scoping. For a destructive tool with no output schema and 50% parameter coverage, this is adequate but leaves notable gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50%, and the description does not explain any parameters. It alludes to confirmation but never mentions the 'confirm' parameter, nor does it clarify 'dns_record_id', 'zone_id', or 'account' beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Permanently removes a DNS record from the zone.' This clearly distinguishes it from sibling read, create, update, and overwrite tools without needing to inspect schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides an invocation guideline—'Every change requires explicit confirmation; never repeat an unknown outcome automatically'—but does not state when to use delete_dns_record rather than update_dns_record, overwrite_dns_record, or other destructive siblings. Usage context is implied but not differentiated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_zone_rulesetDelete a zone rulesetADestructive
Deletes all versions of an existing zone ruleset. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| dry_run | No | Validates the request without persisting changes when set to `true`. Responses that normally return 200 return `result: null`; endpoints that normally return 204 continue to return 204. | |
| zone_id | No | ||
| ruleset_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description still earns credit for disclosing that the deletion spans ALL versions of the ruleset (not just the active one) and for the practical retry rule about not repeating an unknown outcome — exactly the ambiguity an agent faces with a non-idempotent destructive call. It stops short of stating permission requirements or blast radius on dependent resources.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, zero filler, and the destructive scope is front-loaded before the safety guidance. Every sentence carries actionable content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive delete with no output schema, the definition covers what is destroyed and how to behave on ambiguous outcomes, and annotations carry the safety metadata. It is slightly thin on prerequisites (which token/permission is needed) and on the fact that only ruleset_id is required while zone_id/account are optional routing inputs.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description never references any of the five parameters; confirm and dry_run are documented only in the schema. With 60% schema coverage and the $defs supplying ID descriptions for zone_id/ruleset_id, the schema does the heavy lifting, so the baseline of 3 applies — the description adds no syntax, format, or constraint detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Deletes ... an existing zone ruleset") and adds scope precision with "all versions," which distinguishes it from a hypothetical single-version delete. It does not name or contrast any sibling such as update_zone_ruleset or delete_dns_record, so an agent must infer the routing from the name alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
"Every change requires explicit confirmation" gives an invocation precondition, and the retry caution implies this is not something to fire speculatively. However, there is no statement of when this tool is the right choice versus update_zone_ruleset or list_zone_rulesets, and no exclusion guidance — usage is only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dns_recordDNS Record DetailsCRead-onlyIdempotent
Retrieves details for a specific DNS record in the zone. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| dns_record_id | Yes | ||
| include_shadow_metadata | No | Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the description's tagline "Read operation" merely restates structured data. It adds nothing about lookup failures, whether zone_id is needed alongside the record ID, or what the returned record contains.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is appropriately short and the core purpose is front-loaded. The second sentence ("Read operation.") is redundant given the annotations and does not earn its place, which keeps this from a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description should say more about the returned record shape and the zone_id/dns_record_id relationship. Safety behavior is covered by annotations, but the identification and response contract remains thin for a lookup tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50%, and both zone_id and dns_record_id carry empty descriptions. The description provides no compensating detail about how these identifiers relate, whether zone_id is optional, or what include_shadow_metadata changes, leaving key parameters unexplained in both schema and prose.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Retrieves details for a specific DNS record in the zone"), which contrasts with the list_dns_records sibling by emphasizing a single record. The scope is clear, though the description never names the alternative to make the distinction explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance and no mention of alternatives such as list_dns_records or get_zone. The word "specific" weakly implies the caller must already have an ID, but nothing tells the agent when this tool is the right choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_operation_schemaInspect native schemaCRead-onlyIdempotent
Complete selected current API input, path and query schema. Local metadata only.
| Name | Required | Description | Default |
|---|---|---|---|
| operation | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world behavior. The description adds that it is 'Local metadata only' and returns the complete input/path/query schema, reinforcing the read-only nature and specifying the return content, though it does not explain output structure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no wasted words. The scoping information is front-loaded, though the opening noun phrase is grammatically awkward.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 22 enum values and no output schema, the description gives only a high-level notion of what is returned and no usage context. It partially covers the return content but leaves gaps in how an agent should interpret and use the returned schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% for the single 'operation' parameter. The description only implies selection via 'selected', but does not explain that the enum values are operation names or how to choose among them, so it fails to compensate for the missing schema documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description identifies the resource (schema for a selected API operation) and the scope (input, path, and query), but it is phrased as a noun fragment without an explicit verb and does not clearly differentiate from sibling operation tools. An agent can infer the purpose from the name and title, but the description alone is vague.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus executing a sibling operation or using preview_operation. The only hint is 'Local metadata only', which implies read-only inspection, but no explicit conditions, alternatives, or exclusions are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_page_ruleGet a Page RuleBRead-onlyIdempotent
Fetches the details of a Page Rule. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| pagerule_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true. The description's 'Read operation.' restates that safety profile rather than adding new behavioral context. It does not mention auth requirements, rate limits, or what the result includes, so it adds only marginal value beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the core purpose followed by the operation type. There is no wasted text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With three parameters, only one required, incomplete schema descriptions, and no output schema, the definition is too thin. A useful read tool should specify how to identify the Page Rule (pagerule_id plus zone/account context) and what kind of object is returned.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 33%: pagerule_id and zone_id have empty descriptions, and only account has a brief (though obscure) description. The tool description says nothing about parameters, so it fails to compensate for the documentation gap. It should clarify that pagerule_id is the required identifier and that zone_id or account may scope the request.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Fetches the details of a Page Rule.' This clearly distinguishes it from the sibling 'list_page_rules' and write-oriented Page Rule tools. However, it does not explicitly name the sibling or contrast with it, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as list_page_rules or generic zone-ruleset getters. The description offers no context, prerequisites, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_zoneZone DetailsBRead-onlyIdempotent
Retrieves detailed information about a specific zone identified by its zone ID.
Returns zone configuration, status, nameservers, and associated metadata. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds real value by enumerating what is returned (configuration, status, nameservers, metadata), which matters since there is no output schema. It stops short of noting error behavior or account scoping effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The two substantive sentences are front-loaded and waste-free. The trailing 'Read operation.' is redundant with readOnlyHint=true and slightly dilutes the payload.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, enumerating the returned fields is a genuine contribution, but the description leaves the account parameter's routing semantics and the ID format unexplained. For a simple read tool this is adequate but has clear gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 50%: the account parameter is documented, but zone_id's schema description is empty. The description compensates partially by stating the zone is 'identified by its zone ID', but says nothing about the account parameter's role in routing, so the gap is only half filled.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Retrieves') and resource ('zone'), scoped to a single zone identified by ID, which implicitly separates it from list_zones. However, it never names a sibling such as get_zone_setting, so the agent must infer the boundary from scope alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this versus list_zones, get_zone_setting, or get_zone_entrypoint. 'Read operation' restates the annotation rather than describing context or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_zone_entrypointGet a zone entry point rulesetCRead-onlyIdempotent
Fetches the latest version of the zone entry point ruleset for a given phase. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| ruleset_phase | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered; the description's 'Read operation.' merely repeats it. The one genuinely additive detail is that it returns the 'latest version' rather than a specific versioned ruleset, which is modest but real context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded and short, but the second sentence 'Read operation.' earns nothing given the readOnlyHint annotation already present. Roughly half the text is redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description should describe what the returned ruleset contains (rules, version, phase binding), but it says nothing about the response. Combined with undocumented parameters and no usage context, an agent has gaps for a tool whose name suggests a nuanced 'entry point' concept.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33%, so the description should compensate, and it does so only for ruleset_phase ('for a given phase'). The zone_id and account parameters are not explained in the description, and no format or routing semantics (account/zone defaults) are clarified beyond what the schema fragment offers.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Fetches') and resource ('the latest version of the zone entry point ruleset') with a scope qualifier ('for a given phase'). This distinguishes it from sibling get_zone_ruleset and list_zone_rulesets by the 'entry point' + 'latest version' framing, though the differentiation is implicit rather than called out.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no mention of alternatives like get_zone_ruleset despite several ruleset siblings. The trailing 'Read operation.' is a safety restatement, not usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_zone_rulesetGet a zone rulesetCRead-onlyIdempotent
Fetches the latest version of a zone ruleset. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| ruleset_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true and destructiveHint=false, so safety semantics are covered. The description adds one genuinely useful behavioral detail — that it returns the 'latest version' rather than a pinned one — but 'Read operation' merely repeats the annotation and says nothing about versioning history, errors, or response shape.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, front-loaded sentences with no filler; the core action and the read-only nature come first. It is efficient, though the second sentence earns little.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, so the description carries the burden of explaining the returned ruleset, and it says only 'latest version'. Combined with 33% parameter coverage and no usage context, an agent lacks enough to call this confidently beyond the bare minimum.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33% and the description adds no parameter information whatsoever — it never explains ruleset_id (required), zone_id, or the 'account' profile label, nor the zone-vs-account routing hinted at in the schema. With coverage this low, the description is expected to compensate and does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (fetches) and resource (zone ruleset) plus the scope qualifier 'latest version'. This distinguishes it from list_zone_rulesets (plural enumeration) and from create/update/delete_zone_ruleset siblings, though the description never names those alternatives explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Only guidance is the terse 'Read operation.' There is no statement of when to use this versus list_zone_rulesets, update_zone_ruleset, or get_zone, and no prerequisites (e.g., needing a ruleset_id obtained elsewhere) are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_zone_settingGet zone settingCRead-onlyIdempotent
Fetch a single zone setting by name Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| setting_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true and destructiveHint=false. The description's "Read operation" merely restates readOnlyHint and adds no new behavioral context such as auth/permission needs, whether zone_id is required, or what happens when the setting has never been configured.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very short and front-loaded, so it is easy to scan, but the second line "Read operation" is pure redundancy against the annotations and earns no place in the text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with three parameters (one required) at 33% schema coverage and no output schema, the description omits how zone_id and setting_id interact and what the returned setting looks like. An agent has to guess at the lookup scope.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33%, so the description carries the burden of clarifying parameters, but it does not. It says the setting is fetched "by name" while the required parameter is setting_id (a setting name), and it says nothing about the account or zone_id scoping parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Fetch a single zone setting") and scopes it to one item, so an agent can distinguish it from list_zones or get_zone. It does not, however, distinguish itself from the sibling update_zone_setting or explain the relationship to get_zone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus its obvious sibling update_zone_setting, nor any prerequisite or context. The only framing is the bare "Read operation" tag, which is implied by the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_accountsList private profilesCRead-onlyIdempotent
Local profile labels/default/auth method only. No provider IDs, credential values or paths. No network.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false, openWorldHint=false). The description adds useful behavioral context beyond annotations: it clarifies the data returned excludes provider IDs, credential values, and paths, and that there is no network access. However, it doesn't describe the return shape or format, and with annotations doing the safety work, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very short, but it's a series of comma-separated fragments rather than a structured sentence. It's front-loaded with the scope constraint but reads telegraphically and omits the core action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-param list tool with no output schema, the description should at minimum state that it lists local profiles/accounts and roughly what each entry contains. Instead it only describes exclusions, leaving the agent to guess what is actually returned and how it differs from list_provider_accounts.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Zero parameters, so baseline 4 applies. The description adds some semantic value by clarifying what fields are and aren't included in the returned profiles, which is relevant given there are no params to document.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The title 'List private profiles' and name 'list_accounts' suggest listing accounts, but the description only says 'Local profile labels/default/auth method only' — it never states the action (list) or the resource (accounts/profiles) explicitly. It reads as a fragment of a data-scope disclaimer rather than a purpose statement, making it hard to distinguish from sibling 'list_provider_accounts'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No indication of when to use this tool versus 'list_provider_accounts' or any other sibling. There are no alternatives mentioned, no prerequisites, and no context signals to guide selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_dns_recordsList DNS RecordsCRead-onlyIdempotent
List, search, sort, and filter a zones' DNS records. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Condition on the DNS record tag. Parameter values can be of the form `<tag-name>:<tag-value>` to search for an exact `name:value` pair, or just `<tag-name>` to search for records with a specific tag name regardless of its value. This is a convenience shorthand for the more powerful `tag.<predicate>` parameters. Examples: - `tag=important` is equivalent to `tag.present=important` - `tag=team:DNS` is equivalent to `tag.exact=team:DNS` | |
| name | No | Exact value of the DNS record name. This is a convenience alias for `name.exact`. | |
| page | No | ||
| type | No | ||
| match | No | ||
| order | No | ||
| search | No | ||
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| comment | No | Exact value of the DNS record comment. This is a convenience alias for `comment.exact`. | |
| content | No | Exact value of the DNS record content. This is a convenience alias for `content.exact`. | |
| proxied | No | ||
| zone_id | No | ||
| per_page | No | ||
| direction | No | ||
| tag_exact | No | A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value is `<tag-value>`. Tag filters are case-insensitive. | |
| tag_match | No | ||
| name_exact | No | Exact value of the DNS record name. Name filters are case-insensitive. | |
| tag_absent | No | Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive. | |
| tag_present | No | Name of a tag which must be present on the DNS record. Tag filters are case-insensitive. | |
| tag_contains | No | A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value contains `<tag-value>`. Tag filters are case-insensitive. | |
| tag_endswith | No | A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value ends with `<tag-value>`. Tag filters are case-insensitive. | |
| comment_exact | No | Exact value of the DNS record comment. Comment filters are case-insensitive. | |
| content_exact | No | Exact value of the DNS record content. Content filters are case-insensitive. | |
| name_contains | No | Substring of the DNS record name. Name filters are case-insensitive. | |
| name_endswith | No | Suffix of the DNS record name. Name filters are case-insensitive. | |
| comment_absent | No | If this parameter is present, only records *without* a comment are returned. | |
| shadowing_name | No | Returns NS records that shadow the given name, searching at the name itself and each of its ancestor names within the zone, excluding the zone apex. The value must be a subdomain of the zone; the zone apex is not accepted. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). | |
| tag_startswith | No | A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value starts with `<tag-value>`. Tag filters are case-insensitive. | |
| comment_present | No | If this parameter is present, only records *with* a comment are returned. | |
| name_startswith | No | Prefix of the DNS record name. Name filters are case-insensitive. | |
| comment_contains | No | Substring of the DNS record comment. Comment filters are case-insensitive. | |
| comment_endswith | No | Suffix of the DNS record comment. Comment filters are case-insensitive. | |
| content_contains | No | Substring of the DNS record content. Content filters are case-insensitive. | |
| content_endswith | No | Suffix of the DNS record content. Content filters are case-insensitive. | |
| shadowed_by_name | No | Filters the response to records at or below the specified NS delegation name. NS, DS, and NSEC records at the delegation name are excluded because they are not shadowed by that delegation. Those record types are included only when they exist below the delegation. The value must be a non-apex subdomain of the zone. Requires `include_shadow_metadata=true`. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). | |
| comment_startswith | No | Prefix of the DNS record comment. Comment filters are case-insensitive. | |
| content_startswith | No | Prefix of the DNS record content. Content filters are case-insensitive. | |
| include_shadow_metadata | No | Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description's 'Read operation' simply repeats the readOnly annotation and adds no new behavioral context such as pagination behavior, filter interaction, or authentication requirements. With annotations covering safety, this adds no value.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences and front-loads the purpose. The second sentence is redundant with the annotations, so it does not fully earn its place, but the overall brevity is appropriate.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex tool with 38 parameters, the description is minimal but sufficient to understand its core purpose. Rich annotations cover the safety profile and the schema documents most parameters, yet the description does not address filtering alternatives, pagination expectations, or the shadowing parameters, leaving some contextual gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 74%, and most parameters have detailed descriptions in the schema (including $ref definitions) covering filtering, sorting, and pagination semantics. The description only mentions 'search, sort, and filter' in generic terms and adds no syntax or interaction details beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's action (list/search/sort/filter) and resource (DNS records), distinguishing it from single-record siblings like get_dns_record. However, it does not explicitly name an alternative or scope boundary, so it lacks the sibling differentiation that would earn a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as get_dns_record, nor any prerequisites or exclusions. The only contextual note, 'Read operation,' describes the operation type but does not help an agent choose among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_page_rulesList Page RulesCRead-onlyIdempotent
Fetches Page Rules in a zone. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| match | No | When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match. | all |
| order | No | The field used to sort returned Page Rules. | priority |
| status | No | The status of the Page Rule. | disabled |
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| direction | No | The direction used to sort returned Page Rules. | desc |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the description's 'Read operation' sentence merely restates the safety profile. It discloses nothing new about auth needs, pagination, or result volume that the annotations don't cover.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the core action, with no padding. The second sentence is somewhat redundant against the readOnlyHint annotation, keeping it out of 5 territory.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, 6 parameters covering filtering and sorting, and no required parameters, the description should explain the listing/filter behavior and return shape. It does neither, leaving the agent with only a one-line summary for a moderately complex list tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 83%, so the schema already documents match, order, status, direction and account. The description contributes no additional meaning about these filters or their interaction, which is the baseline 3 posture when schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Fetches) and resource (Page Rules) scoped to a zone, which lets an agent distinguish it from the singular sibling get_page_rule. It falls short of a 5 because it never explicitly routes away from that sibling or names any alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description offers no when-to-use guidance, no reference to get_page_rule for single-rule retrieval, and no mention of the filtering/sorting context implied by its 6 parameters. An agent must infer placement entirely from the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_provider_accountsList AccountsBRead-onlyIdempotent
List all accounts you have ownership or verified access to. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Name of the account. | |
| page | No | Page number of paginated results. | |
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| per_page | No | Maximum number of results per page. | |
| direction | No | Direction to order results. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so 'Read operation' adds nothing. The one genuinely additive detail is that results are limited to accounts the caller owns or has verified access to, a scoping constraint beyond structured data.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is very short, but the second sentence ('Read operation.') is pure redundancy with the readOnlyHint annotation and earns no place. The substantive scope information is appropriately front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list tool with 100% schema coverage and annotations covering the safety profile, little is needed. The notable omission is sibling disambiguation against list_accounts, which an agent needs to route correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with zero required parameters, so the schema fully documents pagination (page, per_page), ordering (direction), and filters (name, account). The description adds no parameter-level meaning, which is the expected baseline when the schema carries the load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb and resource ('List all accounts') plus a scope qualifier ('ownership or verified access'). However, it never differentiates itself from the sibling tool list_accounts, leaving the agent to guess which listing tool applies.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use or when-not-to-use guidance. The only usage signal is 'Read operation,' which merely restates the readOnlyHint annotation and does not help select between this and list_accounts.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_workersList Worker ScriptsCRead-onlyIdempotent
Fetch a list of uploaded Worker scripts. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'. | |
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| account_id | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, and destructiveHint=false. The description adds 'Read operation,' which merely repeats the readOnly annotation and provides no additional behavioral context such as pagination, result limits, authentication requirements, or whether the listing spans accounts. With annotations covering the safety profile, the description contributes almost nothing beyond them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loads the purpose, but the second sentence 'Read operation' is redundant with the readOnly annotation and does not earn its place. The overall brevity is appropriate for a simple list operation, yet it omits more useful context that could have been included instead.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a list tool with three optional parameters, no required parameters, and no output schema, the description is under-specified. It does not explain what the returned list contains, how pagination works, or how the optional filters affect results. While the annotations cover read safety, the description leaves too much for the agent to infer.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 67%, with 'tags' and 'account' documented in the schema but 'account_id' left without a description. The tool description provides no parameter meaning at all, so it does not compensate for the partially documented schema or clarify the empty account_id description. It adds no semantic value beyond the raw schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Fetch a list of uploaded Worker scripts'), which is clearer than a pure tautology. However, it does not distinguish this tool from the many other list_* siblings (e.g., list_zones, list_dns_records) beyond the resource name already present in the tool name. The scope of what a 'Worker script' includes and whether it is account-scoped or zone-scoped is left implicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives, no mention of prerequisites, and no indication of what filters or account context are appropriate. The description simply states the operation without any usage framing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_zone_rulesetsList zone rulesetsCRead-onlyIdempotent
Fetches all rulesets at the zone level. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | ||
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| zone_id | No | ||
| per_page | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the description's sole behavioral claim ('Read operation') is a restatement rather than added context. Nothing is said about pagination behavior, result size, or auth requirements despite 4 parameters covering cursor/per_page/account.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Very short and front-loaded, which is good, but the second sentence ('Read operation.') duplicates the annotation block and earns no place. One wasted sentence out of two is a real efficiency cost.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a paginated list tool with no output schema and 25% schema coverage, the definition omits pagination semantics, default page size, and what a 'ruleset' contains. An agent can form the call but not predict its behavior or navigate results.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 25% and the description adds zero parameter meaning: it never explains cursor, per_page limits/defaults, or how the 'account' label routes the request. With a low-coverage schema, the description was expected to compensate and does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource with scope: 'Fetches all rulesets at the zone level.' Clear enough to separate it from get_zone_ruleset (single) and create/update/delete_zone_ruleset (mutations). It does not explicitly name a sibling, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no mention of alternatives such as get_zone_ruleset or list_page_rules. The only usage signal is 'Read operation,' which is already conveyed by annotations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_zonesList ZonesARead-onlyIdempotent
Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed. Read operation.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | A domain name. Optional filter operators can be provided to extend refine the search: * `equal` (default) * `not_equal` * `starts_with` * `ends_with` * `contains` * `starts_with_case_sensitive` * `ends_with_case_sensitive` * `contains_case_sensitive` | |
| page | No | Page number of paginated results. | |
| type | No | Zone types to filter by. Multiple types can be specified as a comma-separated list (e.g., ?type=full,partial,secondary). When this parameter is not provided, zones with type "internal" are excluded from the results. | |
| match | No | Whether to match all search requirements or at least one (any). | all |
| order | No | Field to order zones by. | |
| status | No | Specify a zone status to filter by. | |
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| per_page | No | Number of zones per page. | |
| direction | No | Direction to order zones. | |
| account_id | No | Filter by an account ID. | |
| account_name | No | An account Name. Optional filter operators can be provided to extend refine the search: * `equal` (default) * `not_equal` * `starts_with` * `ends_with` * `contains` * `starts_with_case_sensitive` * `ends_with_case_sensitive` * `contains_case_sensitive` |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so 'Read operation.' adds nothing. The genuinely additive content is the 500-account cap, which is a real operational constraint an agent cannot derive from annotations or schema. Return shape and pagination behavior are not disclosed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences, front-loaded with the core verb and resource, with the constraint stated early. The sentence 'Read operation.' is redundant with readOnlyHint and slightly dilutes an otherwise tight description.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Wait—reassess: with 11 optional parameters fully documented in the schema and rich annotations covering safety and idempotency, the only real gaps are output shape and pagination semantics, and no output schema exists to cover them. For a paginated list tool this leaves a moderate rather than severe gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, including filter-operator syntax, enum values, defaults, and the note that internal zones are excluded when type is omitted, so the baseline of 3 applies. The description contributes nothing beyond the schema (e.g., it never mentions that filters exist or that results paginate).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific compound verb set (lists, searches, sorts, filters) on a named resource (zones), so the agent knows exactly what the tool does. It does not, however, distinguish itself from get_zone or list_provider_accounts, so the agent must infer that 'list' means collection retrieval versus single-zone lookup.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: a read listing tool for zones, plus a hard constraint that listing across more than 500 accounts is currently not allowed. There is no explicit statement of when to prefer this over get_zone or the account-listing siblings, so the guidance is partial rather than directive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
overwrite_dns_recordOverwrite DNS RecordADestructive
Overwrite an existing DNS record.
Notes:
A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. | |
| dns_record_id | Yes | ||
| include_shadow_metadata | No | Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructive=true, idempotent=false, openWorld=true, so the safety profile is partly covered. The description still adds real behavioral value: the record-type exclusivity constraints, Punycode normalization of names, the explicit-confirmation requirement, and the 'never repeat an unknown outcome automatically' rule. It stops short of stating whether the overwrite is a full replacement of all existing fields or a merge.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded in a single sentence, followed by tightly scoped bullet notes and one safety sentence. Every line carries information; the confirmation sentence is slightly tangential to the purpose statement but still earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, 7-parameter tool with deeply nested payload variants and no output schema, the description covers constraints and confirmation but omits the overwrite-vs-update distinction, the two payload transport options (payload vs. payload_file), and any note on failure/rollback behavior. Adequate but incomplete for the tool's complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 71%, so the schema documents much of the nested payload. The description adds one useful semantic (names are always Punycode even when created from Unicode) but says nothing about how confirm, account, payload vs. payload_file, or zone_id should be used, so it only marginally extends the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening sentence gives a specific verb (overwrite) and resource (existing DNS record), so the core action is unambiguous. It does not, however, distinguish itself from the sibling tools update_dns_record, create_dns_record, or delete_dns_record, which matters here because 'overwrite' vs 'update' semantics differ materially.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The notes imply usage conditions by flagging conflicts (A/AAAA vs CNAME, NS exclusivity) that constrain when an overwrite is valid, and the closing sentence signals that confirmation is needed. But there is no explicit when-to-use-this-vs-update_dns_record guidance, leaving the key routing decision to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
preview_dns_batchReview DNS batchBRead-onlyIdempotent
Local schema-validated DNS batch review capped at 50 actions. Digest binds exact JSON body, zone path and profile label; no account or DNS state read. Not a provider authorization grant.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | ||
| payload | No | ||
| zone_id | No | ||
| payload_file | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world). The description adds genuinely new behavior: a 50-action cap, the fact that the digest binds the exact JSON body plus zone path and profile label, and that no account or DNS state is read. It does not say what happens if the cap is exceeded or what the digest is returned for.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences with the defining constraint ('local schema-validated', 'capped at 50 actions') front-loaded, then the digest semantics. Dense but not padded; the terseness borders on cryptic, which costs it the top score.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-output-schema preview tool with a deeply nested payload and four undocumented parameters, the description covers the cap, the non-authorization nature, and the digest binding — useful — but leaves payload_file, the batch operation arrays, and cap-exceeded behavior unexplained, so an agent can invoke it only approximately.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% across four parameters, so the description carries the full burden. 'Exact JSON body', 'zone path', and 'profile label' loosely gesture at payload, zone_id, and account, but payload_file is entirely unaddressed and nothing explains the relationship between payload and payload_file or the puts/posts/patches/deletes structure.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('DNS batch review') and qualifies it as 'local schema-validated' and 'capped at 50 actions', which distinguishes it as a dry-run rather than an applying operation. It separates itself from write siblings by declaring 'no account or DNS state read', though it never names preview_operation or apply_dns_batch explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The dry-run nature implies you use it before applying a batch, and 'Not a provider authorization grant' clarifies a boundary, but the description never states when to choose this over preview_operation or batch_dns_records, nor any prerequisite or ordering with apply_dns_batch. Usage is inferable but not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
preview_operationPreview selected requestARead-onlyIdempotent
Validate a named operation and return its exact local method/path/query/body/profile. No request, auth validation or provider policy checks.
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | Yes | ||
| operation | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the bar is lower. The description still adds real value by disclosing that no request is sent and no auth/provider policy validation occurs — an important scoping fact an agent could not infer from the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences: the positive purpose is front-loaded and the negative scoping caveat follows immediately. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description usefully names the returned fields (method/path/query/body/profile). However, for a tool with a nested, undocumented 'arguments' parameter it should say how arguments map to the operation, which is the main missing piece.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It gestures at 'a named operation' matching the enum, but says nothing about the required 'arguments' object (a nested structure that presumably supplies the operation's inputs), leaving half the parameters undocumented.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (validate) and resource (a named operation), and specifies exactly what it returns: the local method/path/query/body/profile. This distinguishes it from siblings like apply_dns_batch and preview_dns_batch, though it never names them explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The clause 'No request, auth validation or provider policy checks' communicates a negative boundary (this is a local/syntactic preview only), which implicitly suggests using a real apply tool when provider validation is needed. But it never states when to choose this over get_operation_schema or preview_dns_batch, leaving the routing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
purge_cachePurge Cached ContentADestructive
Deletes cached content in every Cloudflare data center and cache tier, including Cache Reserve. The next request for purged content is a cache MISS: Cloudflare fetches the full response from your origin and caches it again. Cloudflare does not serve purged content from cache again, even if your origin is unavailable.
To keep content cached and have Cloudflare revalidate it with your origin instead, use POST /zones/{zone_id}/invalidate_cache.
Choose what to purge
Send one of these fields in the request body:
files: specific URLs. If your cache key includes request headers, send each URL with the header values it was cached with.tags: all content whoseCache-Tagresponse header contains one of the tags.hosts: all content cached for the hostnames.prefixes: all content whose URL starts with one of the prefixes.purge_everything: all cached content in the zone.
Check the result
A 200 response with success: true means Cloudflare accepted the request. It does not confirm that any content was cached or removed. To check, request a purged URL and confirm that the CF-Cache-Status response header is MISS.
Availability and limits
Rate limits and the number of items you can send in one request depend on your plan. See Purge cache: availability and limits. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | The zone ID. | |
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag destructive and non-idempotent, but the description goes further: it explains the concrete consequence (origin refetch, purged content never served from cache even if origin is down), the confirmation requirement ('Every change requires explicit confirmation; never repeat an unknown outcome automatically'), and plan-dependent rate limits. That is rich behavioral context beyond the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose and organized under clear headers (Choose what to purge, Check the result, Availability and limits). It is longer than typical but nearly every sentence carries operational value; a minor trim of the repeated verification caveat would tighten it.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, zone-scoped operation with no output schema, the description covers scope, semantics, the caveat that `success: true` does not confirm removal, how to verify via `CF-Cache-Status`, and limits. Nothing an agent needs to invoke it safely is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds synthesis value by grouping the anyOf body variants by intent and stating the exclusivity rule ('Send one of these fields'), helping the agent pick the right purge mode, though the individual field semantics mostly mirror the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource with scope: 'Deletes cached content in every Cloudflare data center and cache tier, including Cache Reserve.' It also explains the post-purge behavior (next request is a MISS) and names the sibling endpoint for the alternative behavior, so an agent can distinguish this from a revalidation tool without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly routes between this tool and `POST /zones/{zone_id}/invalidate_cache` based on intent (revalidate vs. evict). It also enumerates the mutually exclusive purge modes and tells the agent how to verify the outcome.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
query_pagesBounded native pagesBRead-onlyIdempotent
Read at most five pages of a supported paginated named operation. Provider page metadata determines continuation; missing metadata stops with an explicit unknown continuation.
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | Yes | ||
| max_pages | No | ||
| operation | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered. The description still adds real value beyond them: the hard 5-page cap and the continuation rule (provider metadata drives continuation; absent metadata yields an explicit unknown continuation), which tells the agent how to interpret a truncated result.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tightly written sentences with the scope constraint front-loaded and no filler. The second sentence is somewhat dense but each clause (continuation source, missing-metadata outcome) earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with a nested-object parameter, 0% schema coverage and no output schema, the description is too thin: it omits how 'arguments' must be formed and what a page result contains. The continuation note is the only substantive detail.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% with three parameters including a nested 'arguments' object, so the description must carry the load. It only loosely maps 'at most five pages' to max_pages and never explains the operation enum or the shape/semantics of the arguments object, leaving the most error-prone parameter undocumented.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Read) and resource (pages of a supported paginated named operation) with an explicit bound of five pages. It does not name which operations are 'supported' (the schema enum does that) nor distinguish itself from the sibling list_zones/list_dns_records tools it presumably wraps, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance: it never says why an agent should call query_pages instead of the direct list_zones / list_dns_records siblings, nor when a single-page versus multi-page read is appropriate. Only the continuation behavior is implied, which is behavioral rather than selection guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_dns_recordUpdate DNS RecordBDestructive
Update an existing DNS record.
Notes:
A/AAAA records cannot exist on the same name as CNAME records.
NS records cannot exist on the same name as any other record type.
Domain names are always represented in Punycode, even if Unicode characters were used when creating the record. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. | |
| dns_record_id | Yes | ||
| include_shadow_metadata | No | Whether to include shadow metadata in the `meta` field of each record in the response. See [Shadowed records](https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false, and readOnlyHint=false, but the description adds genuinely useful behavioral context: mandatory explicit confirmation and a safety rule against automatically repeating an unknown outcome, plus DNS coexistence invariants. This meaningfully lowers retry/confirmation risk beyond what the annotations convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the core action in one line, then uses short bullets for the invariants and confirmation rule. No filler sentences; appropriately sized for the operation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive update with a deeply nested payload schema and no output schema, the description covers confirmation and key DNS invariants but omits how partial updates interact with existing values, the payload/payload_file exclusivity, and permission requirements. Adequate but with visible gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 71%, so the schema carries most parameter documentation. The description adds only marginal semantics — the Punycode rule for the name field and the confirmation requirement tied to confirm — and says nothing about payload vs payload_file or zone_id selection.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Update an existing DNS record"), so the operation is unambiguous. However, it offers no differentiation from the closely related sibling overwrite_dns_record, leaving the update-vs-overwrite choice to the agent's inference.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit guidance on when to use this tool versus overwrite_dns_record, delete_dns_record, or batch alternatives. The only usage-adjacent line ("Every change requires explicit confirmation") instructs on the confirm parameter rather than routing between tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_zone_rulesetUpdate a zone rulesetADestructive
Updates a zone ruleset, creating a new version. Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| dry_run | No | Validates the request without persisting changes when set to `true`. Responses that normally return 200 return `result: null`; endpoints that normally return 204 continue to return 204. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| ruleset_id | Yes | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructive=true, idempotent=false, openWorld=true, so the safety profile is covered. The description adds value beyond that by disclosing the versioning behavior (each update makes a new version) and the confirmation/retry-safety requirement, which are not derivable from annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the core action and behavior. Nothing is padded, though the confirmation sentence is slightly ambiguous in wording ("unknown outcome").
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 7-parameter destructive mutation with a large nested payload and no output schema, the description is thin. It omits any guidance on version conflicts, dry_run semantics, or payload/payload_file exclusivity, leaving those gaps to the schema alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 71%, so the baseline is 3. The description only vaguely gestures at the confirm parameter via "explicit confirmation" and says nothing about dry_run, zone_id, ruleset_id, or the payload vs payload_file distinction.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Updates a zone ruleset") plus a useful behavioral fact ("creating a new version"). However it never names the sibling alternatives create_zone_ruleset or delete_zone_ruleset to differentiate the update path from them.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The line about explicit confirmation and not repeating an unknown outcome gives implied operational guidance, but there is no explicit when-to-use statement, no prerequisites, and no comparison against the sibling create/delete ruleset tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_zone_settingEdit zone settingBDestructive
Updates a single zone setting by the identifier Every change requires explicit confirmation; never repeat an unknown outcome automatically.
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Exact private profile label. Account/zone defaults route inputs; token permissions remain provider controlled. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete current native JSON request body. Do not mix with payload_file. | |
| zone_id | No | ||
| setting_id | Yes | ||
| payload_file | No | Regular non-symlink local JSON request file, at most 1 MiB. No credentials in public files. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description still adds value beyond them by stating the explicit-confirmation requirement and the don't-retry-on-unknown-outcome rule, which directly operationalizes the non-idempotency hint.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tightly written sentences with the core action front-loaded and the confirmation caveat second. Nothing is redundant, though the second sentence leans on schema-defined terms without elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive mutation with a very large polymorphic payload and no output schema, the description is thin on how to shape the payload or which settings accept which value types. Annotations and the rich schema cover enough that the tool is callable, but the description does little to orient an agent through the complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 67%, below the high-coverage threshold, and the description only alludes to "the identifier" without clarifying zone_id vs setting_id or the confirm/payload/payload_file relationship. It adds essentially nothing to the parameter semantics the schema already carries.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ("Updates a single zone setting") and adds the scoping detail "by the identifier," so an agent can distinguish it from read siblings like get_zone_setting. It does not, however, name an alternative or contrast with other mutation tools (update_zone_ruleset, etc.).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
"Every change requires explicit confirmation" gives one usage precondition (the confirm flag), and "never repeat an unknown outcome automatically" warns against blind retries. But there is no explicit when-to-use vs when-not or routing to get_zone_setting for reads, so guidance is only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
12 tool updates
v3.0.1- Changed
apply_dns_batch155 fields changed- added
Input schema / $defs / dns-records_dns-record-post / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / $defs / dns-records_dns-record-post / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / $defs / dns-records_dns-record-post / typeRemoved value: -"object" - added
Input schema / properties / confirm / descriptionAdded value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / dns-records_AAAARecord / $refAdded value: +"#/$defs/dns-records_AAAARecord" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv6 address.", - "format": "ipv6", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "AAAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / titleRemoved value: -"AAAA Record" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_ARecord / $refAdded value: +"#/$defs/dns-records_ARecord" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv4 address.", - "format": "ipv4", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "A" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ARecord / titleRemoved value: -"A Record" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CAARecord / $refAdded value: +"#/$defs/dns-records_CAARecord" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CAA content. See 'data' to set CAA properties.", - "type": "string" - }, - "data": { - "description": "Components of a CAA record.", - "properties": { - "flags": { - "description": "Flags for the CAA record.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "tag": { - "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", - "type": "string" - }, - "value": { - "description": "Value of the record. This field's semantics depend on the chosen tag.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / titleRemoved value: -"CAA Record" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CERTRecord / $refAdded value: +"#/$defs/dns-records_CERTRecord" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CERT content. See 'data' to set CERT properties.", - "type": "string" - }, - "data": { - "description": "Components of a CERT record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "type": { - "description": "Type.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CERT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / titleRemoved value: -"CERT Record" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CNAMERecord / $refAdded value: +"#/$defs/dns-records_CNAMERecord" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid hostname. Must not match the record's name.", - "type": "string" - }, - "settings": { - "properties": { - "flatten_cname": { - "default": false, - "description": "If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CNAME" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / titleRemoved value: -"CNAME Record" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / $refAdded value: +"#/$defs/dns-records_DNSKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", - "type": "string" - }, - "data": { - "description": "Components of a DNSKEY record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "flags": { - "description": "Flags.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "protocol": { - "description": "Protocol.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "public_key": { - "description": "Public Key.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DNSKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / titleRemoved value: -"DNSKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DSRecord / $refAdded value: +"#/$defs/dns-records_DSRecord" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DS content. See 'data' to set DS properties.", - "type": "string" - }, - "data": { - "description": "Components of a DS record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "digest": { - "description": "Digest.", - "type": "string" - }, - "digest_type": { - "description": "Digest Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / titleRemoved value: -"DS Record" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / $refAdded value: +"#/$defs/dns-records_HTTPSRecord" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", - "type": "string" - }, - "data": { - "description": "Components of a HTTPS record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "HTTPS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / titleRemoved value: -"HTTPS Record" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_LOCRecord / $refAdded value: +"#/$defs/dns-records_LOCRecord" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted LOC content. See 'data' to set LOC properties.", - "type": "string" - }, - "data": { - "description": "Components of a LOC record.", - "properties": { - "altitude": { - "description": "Altitude of location in meters.", - "maximum": 42849672.95, - "minimum": -100000, - "type": "number" - }, - "lat_degrees": { - "description": "Degrees of latitude.", - "maximum": 90, - "minimum": 0, - "type": "number" - }, - "lat_direction": { - "description": "Latitude direction.", - "enum": [ - "N", - "S" - ], - "type": "string" - }, - "lat_minutes": { - "description": "Minutes of latitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "lat_seconds": { - "description": "Seconds of latitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "long_degrees": { - "description": "Degrees of longitude.", - "maximum": 180, - "minimum": 0, - "type": "number" - }, - "long_direction": { - "description": "Longitude direction.", - "enum": [ - "E", - "W" - ], - "type": "string" - }, - "long_minutes": { - "description": "Minutes of longitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "long_seconds": { - "description": "Seconds of longitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "precision_horz": { - "description": "Horizontal precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "precision_vert": { - "description": "Vertical precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "size": { - "description": "Size of location in meters.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "LOC" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / titleRemoved value: -"LOC Record" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_MXRecord / $refAdded value: +"#/$defs/dns-records_MXRecord" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid mail server hostname.", - "format": "hostname", - "type": "string" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "MX" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / titleRemoved value: -"MX Record" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / $refAdded value: +"#/$defs/dns-records_NAPTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", - "type": "string" - }, - "data": { - "description": "Components of a NAPTR record.", - "properties": { - "flags": { - "description": "Flags.", - "type": "string" - }, - "order": { - "description": "Order.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "preference": { - "description": "Preference.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "regex": { - "description": "Regex.", - "type": "string" - }, - "replacement": { - "description": "Replacement.", - "type": "string" - }, - "service": { - "description": "Service.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "NAPTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / titleRemoved value: -"NAPTR Record" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NSRecord / $refAdded value: +"#/$defs/dns-records_NSRecord" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid name server host name.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "NS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / titleRemoved value: -"NS Record" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / $refAdded value: +"#/$defs/dns-records_OPENPGPKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "OPENPGPKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / titleRemoved value: -"OPENPGPKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_PTRRecord / $refAdded value: +"#/$defs/dns-records_PTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Domain name pointing to the address.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "PTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / titleRemoved value: -"PTR Record" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / $refAdded value: +"#/$defs/dns-records_SMIMEARecord" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", - "type": "string" - }, - "data": { - "description": "Components of a SMIMEA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SMIMEA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / titleRemoved value: -"SMIMEA Record" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SRVRecord / $refAdded value: +"#/$defs/dns-records_SRVRecord" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", - "type": "string" - }, - "data": { - "description": "Components of a SRV record.", - "properties": { - "port": { - "description": "The port of the service.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "target": { - "description": "A valid hostname.", - "format": "hostname", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SRV" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / titleRemoved value: -"SRV Record" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / $refAdded value: +"#/$defs/dns-records_SSHFPRecord" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", - "type": "string" - }, - "data": { - "description": "Components of a SSHFP record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "fingerprint": { - "description": "Fingerprint.", - "type": "string" - }, - "type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SSHFP" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / titleRemoved value: -"SSHFP Record" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SVCBRecord / $refAdded value: +"#/$defs/dns-records_SVCBRecord" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SVCB content. See 'data' to set SVCB properties.", - "type": "string" - }, - "data": { - "description": "Components of a SVCB record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SVCB" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / titleRemoved value: -"SVCB Record" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TLSARecord / $refAdded value: +"#/$defs/dns-records_TLSARecord" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted TLSA content. See 'data' to set TLSA properties.", - "type": "string" - }, - "data": { - "description": "Components of a TLSA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "TLSA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / titleRemoved value: -"TLSA Record" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TXTRecord / $refAdded value: +"#/$defs/dns-records_TXTRecord" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at <https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/>.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "TXT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / titleRemoved value: -"TXT Record" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_URIRecord / $refAdded value: +"#/$defs/dns-records_URIRecord" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted URI content. See 'data' to set URI properties.", - "type": "string" - }, - "data": { - "description": "Components of a URI record.", - "properties": { - "target": { - "description": "The record content.", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "URI" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / titleRemoved value: -"URI Record" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_comment / $refAdded value: +"#/$defs/dns-records_comment" - removed
Input schema / properties / payload / $defs / dns-records_comment / descriptionRemoved value: -"Comments or notes about the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_comment / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / $refAdded value: +"#/$defs/dns-records_dns-record-batch-delete" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / allOfRemoved value: -[ - { - "properties": { - "id": { - "$ref": "#/$defs/dns-records_identifier" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / $refAdded value: +"#/$defs/dns-records_dns-record-batch-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-patch" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / propertiesRemoved value: -{ - "id": { - "$ref": "#/$defs/dns-records_identifier" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / $refAdded value: +"#/$defs/dns-records_dns-record-batch-post" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-post" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / $refAdded value: +"#/$defs/dns-records_dns-record-batch-put" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-post" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / propertiesRemoved value: -{ - "id": { - "$ref": "#/$defs/dns-records_identifier" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-patch / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-patch / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-patch / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-post / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-post / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / $refAdded value: +"#/$defs/dns-records_dns-record-shared-fields" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / propertiesRemoved value: -{ - "comment": { - "$ref": "#/$defs/dns-records_comment" - }, - "name": { - "$ref": "#/$defs/dns-records_name" - }, - "proxied": { - "$ref": "#/$defs/dns-records_proxied" - }, - "settings": { - "$ref": "#/$defs/dns-records_settings" - }, - "tags": { - "$ref": "#/$defs/dns-records_tags" - }, - "ttl": { - "$ref": "#/$defs/dns-records_ttl" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / $refAdded value: +"#/$defs/dns-records_dns-record-with-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_CAARecord" - }, - { - "$ref": "#/$defs/dns-records_CERTRecord" - }, - { - "$ref": "#/$defs/dns-records_DNSKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_DSRecord" - }, - { - "$ref": "#/$defs/dns-records_HTTPSRecord" - }, - { - "$ref": "#/$defs/dns-records_LOCRecord" - }, - { - "$ref": "#/$defs/dns-records_NAPTRRecord" - }, - { - "$ref": "#/$defs/dns-records_SMIMEARecord" - }, - { - "$ref": "#/$defs/dns-records_SRVRecord" - }, - { - "$ref": "#/$defs/dns-records_SSHFPRecord" - }, - { - "$ref": "#/$defs/dns-records_SVCBRecord" - }, - { - "$ref": "#/$defs/dns-records_TLSARecord" - }, - { - "$ref": "#/$defs/dns-records_URIRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / $refAdded value: +"#/$defs/dns-records_dns-record-without-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_ARecord" - }, - { - "$ref": "#/$defs/dns-records_AAAARecord" - }, - { - "$ref": "#/$defs/dns-records_CNAMERecord" - }, - { - "$ref": "#/$defs/dns-records_MXRecord" - }, - { - "$ref": "#/$defs/dns-records_NSRecord" - }, - { - "$ref": "#/$defs/dns-records_OPENPGPKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_PTRRecord" - }, - { - "$ref": "#/$defs/dns-records_TXTRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_identifier / $refAdded value: +"#/$defs/dns-records_identifier" - removed
Input schema / properties / payload / $defs / dns-records_identifier / descriptionRemoved value: -"Identifier." - removed
Input schema / properties / payload / $defs / dns-records_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / dns-records_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_name / $refAdded value: +"#/$defs/dns-records_name" - removed
Input schema / properties / payload / $defs / dns-records_name / descriptionRemoved value: -"Complete DNS record name, including the zone name, in Punycode." - removed
Input schema / properties / payload / $defs / dns-records_name / maxLengthRemoved value: -255 - removed
Input schema / properties / payload / $defs / dns-records_name / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_priority / $refAdded value: +"#/$defs/dns-records_priority" - removed
Input schema / properties / payload / $defs / dns-records_priority / descriptionRemoved value: -"Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map." - removed
Input schema / properties / payload / $defs / dns-records_priority / maximumRemoved value: -65535 - removed
Input schema / properties / payload / $defs / dns-records_priority / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / dns-records_priority / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / dns-records_proxied / $refAdded value: +"#/$defs/dns-records_proxied" - removed
Input schema / properties / payload / $defs / dns-records_proxied / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / dns-records_proxied / descriptionRemoved value: -"Whether the record is receiving the performance and security benefits of Cloudflare." - removed
Input schema / properties / payload / $defs / dns-records_proxied / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / dns-records_settings / $refAdded value: +"#/$defs/dns-records_settings" - removed
Input schema / properties / payload / $defs / dns-records_settings / descriptionRemoved value: -"Settings for the DNS record." - removed
Input schema / properties / payload / $defs / dns-records_settings / propertiesRemoved value: -{ - "ipv4_only": { - "default": false, - "description": "When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - }, - "ipv6_only": { - "default": false, - "description": "When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / dns-records_settings / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_tags / $refAdded value: +"#/$defs/dns-records_tags" - removed
Input schema / properties / payload / $defs / dns-records_tags / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / dns-records_tags / descriptionRemoved value: -"Custom tags for the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_tags / itemsRemoved value: -{ - "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", - "type": "string" -} - removed
Input schema / properties / payload / $defs / dns-records_tags / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / dns-records_ttl / $refAdded value: +"#/$defs/dns-records_ttl" - removed
Input schema / properties / payload / $defs / dns-records_ttl / anyOfRemoved value: -[ - { - "maximum": 86400, - "minimum": 30, - "type": "number" - }, - { - "enum": [ - 1 - ], - "type": "number" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ttl / defaultRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_ttl / descriptionRemoved value: -"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones." - removed
Input schema / properties / payload / $defs / dns-records_ttl / typeRemoved value: -"number"
- Changed
batch_dns_records155 fields changed- added
Input schema / $defs / dns-records_dns-record-post / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / $defs / dns-records_dns-record-post / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / $defs / dns-records_dns-record-post / typeRemoved value: -"object" - changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / dns-records_AAAARecord / $refAdded value: +"#/$defs/dns-records_AAAARecord" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv6 address.", - "format": "ipv6", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "AAAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / titleRemoved value: -"AAAA Record" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_ARecord / $refAdded value: +"#/$defs/dns-records_ARecord" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv4 address.", - "format": "ipv4", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "A" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ARecord / titleRemoved value: -"A Record" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CAARecord / $refAdded value: +"#/$defs/dns-records_CAARecord" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CAA content. See 'data' to set CAA properties.", - "type": "string" - }, - "data": { - "description": "Components of a CAA record.", - "properties": { - "flags": { - "description": "Flags for the CAA record.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "tag": { - "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", - "type": "string" - }, - "value": { - "description": "Value of the record. This field's semantics depend on the chosen tag.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / titleRemoved value: -"CAA Record" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CERTRecord / $refAdded value: +"#/$defs/dns-records_CERTRecord" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CERT content. See 'data' to set CERT properties.", - "type": "string" - }, - "data": { - "description": "Components of a CERT record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "type": { - "description": "Type.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CERT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / titleRemoved value: -"CERT Record" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CNAMERecord / $refAdded value: +"#/$defs/dns-records_CNAMERecord" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid hostname. Must not match the record's name.", - "type": "string" - }, - "settings": { - "properties": { - "flatten_cname": { - "default": false, - "description": "If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CNAME" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / titleRemoved value: -"CNAME Record" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / $refAdded value: +"#/$defs/dns-records_DNSKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", - "type": "string" - }, - "data": { - "description": "Components of a DNSKEY record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "flags": { - "description": "Flags.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "protocol": { - "description": "Protocol.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "public_key": { - "description": "Public Key.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DNSKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / titleRemoved value: -"DNSKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DSRecord / $refAdded value: +"#/$defs/dns-records_DSRecord" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DS content. See 'data' to set DS properties.", - "type": "string" - }, - "data": { - "description": "Components of a DS record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "digest": { - "description": "Digest.", - "type": "string" - }, - "digest_type": { - "description": "Digest Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / titleRemoved value: -"DS Record" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / $refAdded value: +"#/$defs/dns-records_HTTPSRecord" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", - "type": "string" - }, - "data": { - "description": "Components of a HTTPS record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "HTTPS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / titleRemoved value: -"HTTPS Record" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_LOCRecord / $refAdded value: +"#/$defs/dns-records_LOCRecord" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted LOC content. See 'data' to set LOC properties.", - "type": "string" - }, - "data": { - "description": "Components of a LOC record.", - "properties": { - "altitude": { - "description": "Altitude of location in meters.", - "maximum": 42849672.95, - "minimum": -100000, - "type": "number" - }, - "lat_degrees": { - "description": "Degrees of latitude.", - "maximum": 90, - "minimum": 0, - "type": "number" - }, - "lat_direction": { - "description": "Latitude direction.", - "enum": [ - "N", - "S" - ], - "type": "string" - }, - "lat_minutes": { - "description": "Minutes of latitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "lat_seconds": { - "description": "Seconds of latitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "long_degrees": { - "description": "Degrees of longitude.", - "maximum": 180, - "minimum": 0, - "type": "number" - }, - "long_direction": { - "description": "Longitude direction.", - "enum": [ - "E", - "W" - ], - "type": "string" - }, - "long_minutes": { - "description": "Minutes of longitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "long_seconds": { - "description": "Seconds of longitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "precision_horz": { - "description": "Horizontal precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "precision_vert": { - "description": "Vertical precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "size": { - "description": "Size of location in meters.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "LOC" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / titleRemoved value: -"LOC Record" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_MXRecord / $refAdded value: +"#/$defs/dns-records_MXRecord" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid mail server hostname.", - "format": "hostname", - "type": "string" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "MX" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / titleRemoved value: -"MX Record" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / $refAdded value: +"#/$defs/dns-records_NAPTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", - "type": "string" - }, - "data": { - "description": "Components of a NAPTR record.", - "properties": { - "flags": { - "description": "Flags.", - "type": "string" - }, - "order": { - "description": "Order.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "preference": { - "description": "Preference.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "regex": { - "description": "Regex.", - "type": "string" - }, - "replacement": { - "description": "Replacement.", - "type": "string" - }, - "service": { - "description": "Service.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "NAPTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / titleRemoved value: -"NAPTR Record" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NSRecord / $refAdded value: +"#/$defs/dns-records_NSRecord" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid name server host name.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "NS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / titleRemoved value: -"NS Record" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / $refAdded value: +"#/$defs/dns-records_OPENPGPKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "OPENPGPKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / titleRemoved value: -"OPENPGPKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_PTRRecord / $refAdded value: +"#/$defs/dns-records_PTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Domain name pointing to the address.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "PTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / titleRemoved value: -"PTR Record" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / $refAdded value: +"#/$defs/dns-records_SMIMEARecord" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", - "type": "string" - }, - "data": { - "description": "Components of a SMIMEA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SMIMEA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / titleRemoved value: -"SMIMEA Record" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SRVRecord / $refAdded value: +"#/$defs/dns-records_SRVRecord" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", - "type": "string" - }, - "data": { - "description": "Components of a SRV record.", - "properties": { - "port": { - "description": "The port of the service.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "target": { - "description": "A valid hostname.", - "format": "hostname", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SRV" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / titleRemoved value: -"SRV Record" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / $refAdded value: +"#/$defs/dns-records_SSHFPRecord" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", - "type": "string" - }, - "data": { - "description": "Components of a SSHFP record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "fingerprint": { - "description": "Fingerprint.", - "type": "string" - }, - "type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SSHFP" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / titleRemoved value: -"SSHFP Record" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SVCBRecord / $refAdded value: +"#/$defs/dns-records_SVCBRecord" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SVCB content. See 'data' to set SVCB properties.", - "type": "string" - }, - "data": { - "description": "Components of a SVCB record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SVCB" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / titleRemoved value: -"SVCB Record" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TLSARecord / $refAdded value: +"#/$defs/dns-records_TLSARecord" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted TLSA content. See 'data' to set TLSA properties.", - "type": "string" - }, - "data": { - "description": "Components of a TLSA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "TLSA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / titleRemoved value: -"TLSA Record" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TXTRecord / $refAdded value: +"#/$defs/dns-records_TXTRecord" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at <https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/>.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "TXT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / titleRemoved value: -"TXT Record" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_URIRecord / $refAdded value: +"#/$defs/dns-records_URIRecord" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted URI content. See 'data' to set URI properties.", - "type": "string" - }, - "data": { - "description": "Components of a URI record.", - "properties": { - "target": { - "description": "The record content.", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "URI" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / titleRemoved value: -"URI Record" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_comment / $refAdded value: +"#/$defs/dns-records_comment" - removed
Input schema / properties / payload / $defs / dns-records_comment / descriptionRemoved value: -"Comments or notes about the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_comment / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / $refAdded value: +"#/$defs/dns-records_dns-record-batch-delete" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / allOfRemoved value: -[ - { - "properties": { - "id": { - "$ref": "#/$defs/dns-records_identifier" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / $refAdded value: +"#/$defs/dns-records_dns-record-batch-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-patch" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / propertiesRemoved value: -{ - "id": { - "$ref": "#/$defs/dns-records_identifier" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / $refAdded value: +"#/$defs/dns-records_dns-record-batch-post" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-post" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / $refAdded value: +"#/$defs/dns-records_dns-record-batch-put" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-post" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / propertiesRemoved value: -{ - "id": { - "$ref": "#/$defs/dns-records_identifier" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-patch / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-patch / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-patch / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-post / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-post / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / $refAdded value: +"#/$defs/dns-records_dns-record-shared-fields" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / propertiesRemoved value: -{ - "comment": { - "$ref": "#/$defs/dns-records_comment" - }, - "name": { - "$ref": "#/$defs/dns-records_name" - }, - "proxied": { - "$ref": "#/$defs/dns-records_proxied" - }, - "settings": { - "$ref": "#/$defs/dns-records_settings" - }, - "tags": { - "$ref": "#/$defs/dns-records_tags" - }, - "ttl": { - "$ref": "#/$defs/dns-records_ttl" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / $refAdded value: +"#/$defs/dns-records_dns-record-with-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_CAARecord" - }, - { - "$ref": "#/$defs/dns-records_CERTRecord" - }, - { - "$ref": "#/$defs/dns-records_DNSKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_DSRecord" - }, - { - "$ref": "#/$defs/dns-records_HTTPSRecord" - }, - { - "$ref": "#/$defs/dns-records_LOCRecord" - }, - { - "$ref": "#/$defs/dns-records_NAPTRRecord" - }, - { - "$ref": "#/$defs/dns-records_SMIMEARecord" - }, - { - "$ref": "#/$defs/dns-records_SRVRecord" - }, - { - "$ref": "#/$defs/dns-records_SSHFPRecord" - }, - { - "$ref": "#/$defs/dns-records_SVCBRecord" - }, - { - "$ref": "#/$defs/dns-records_TLSARecord" - }, - { - "$ref": "#/$defs/dns-records_URIRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / $refAdded value: +"#/$defs/dns-records_dns-record-without-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_ARecord" - }, - { - "$ref": "#/$defs/dns-records_AAAARecord" - }, - { - "$ref": "#/$defs/dns-records_CNAMERecord" - }, - { - "$ref": "#/$defs/dns-records_MXRecord" - }, - { - "$ref": "#/$defs/dns-records_NSRecord" - }, - { - "$ref": "#/$defs/dns-records_OPENPGPKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_PTRRecord" - }, - { - "$ref": "#/$defs/dns-records_TXTRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_identifier / $refAdded value: +"#/$defs/dns-records_identifier" - removed
Input schema / properties / payload / $defs / dns-records_identifier / descriptionRemoved value: -"Identifier." - removed
Input schema / properties / payload / $defs / dns-records_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / dns-records_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_name / $refAdded value: +"#/$defs/dns-records_name" - removed
Input schema / properties / payload / $defs / dns-records_name / descriptionRemoved value: -"Complete DNS record name, including the zone name, in Punycode." - removed
Input schema / properties / payload / $defs / dns-records_name / maxLengthRemoved value: -255 - removed
Input schema / properties / payload / $defs / dns-records_name / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_priority / $refAdded value: +"#/$defs/dns-records_priority" - removed
Input schema / properties / payload / $defs / dns-records_priority / descriptionRemoved value: -"Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map." - removed
Input schema / properties / payload / $defs / dns-records_priority / maximumRemoved value: -65535 - removed
Input schema / properties / payload / $defs / dns-records_priority / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / dns-records_priority / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / dns-records_proxied / $refAdded value: +"#/$defs/dns-records_proxied" - removed
Input schema / properties / payload / $defs / dns-records_proxied / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / dns-records_proxied / descriptionRemoved value: -"Whether the record is receiving the performance and security benefits of Cloudflare." - removed
Input schema / properties / payload / $defs / dns-records_proxied / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / dns-records_settings / $refAdded value: +"#/$defs/dns-records_settings" - removed
Input schema / properties / payload / $defs / dns-records_settings / descriptionRemoved value: -"Settings for the DNS record." - removed
Input schema / properties / payload / $defs / dns-records_settings / propertiesRemoved value: -{ - "ipv4_only": { - "default": false, - "description": "When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - }, - "ipv6_only": { - "default": false, - "description": "When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / dns-records_settings / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_tags / $refAdded value: +"#/$defs/dns-records_tags" - removed
Input schema / properties / payload / $defs / dns-records_tags / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / dns-records_tags / descriptionRemoved value: -"Custom tags for the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_tags / itemsRemoved value: -{ - "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", - "type": "string" -} - removed
Input schema / properties / payload / $defs / dns-records_tags / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / dns-records_ttl / $refAdded value: +"#/$defs/dns-records_ttl" - removed
Input schema / properties / payload / $defs / dns-records_ttl / anyOfRemoved value: -[ - { - "maximum": 86400, - "minimum": 30, - "type": "number" - }, - { - "enum": [ - 1 - ], - "type": "number" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ttl / defaultRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_ttl / descriptionRemoved value: -"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones." - removed
Input schema / properties / payload / $defs / dns-records_ttl / typeRemoved value: -"number"
- Changed
create_dns_record129 fields changed- changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / dns-records_AAAARecord / $refAdded value: +"#/$defs/dns-records_AAAARecord" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv6 address.", - "format": "ipv6", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "AAAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / titleRemoved value: -"AAAA Record" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_ARecord / $refAdded value: +"#/$defs/dns-records_ARecord" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv4 address.", - "format": "ipv4", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "A" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ARecord / titleRemoved value: -"A Record" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CAARecord / $refAdded value: +"#/$defs/dns-records_CAARecord" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CAA content. See 'data' to set CAA properties.", - "type": "string" - }, - "data": { - "description": "Components of a CAA record.", - "properties": { - "flags": { - "description": "Flags for the CAA record.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "tag": { - "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", - "type": "string" - }, - "value": { - "description": "Value of the record. This field's semantics depend on the chosen tag.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / titleRemoved value: -"CAA Record" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CERTRecord / $refAdded value: +"#/$defs/dns-records_CERTRecord" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CERT content. See 'data' to set CERT properties.", - "type": "string" - }, - "data": { - "description": "Components of a CERT record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "type": { - "description": "Type.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CERT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / titleRemoved value: -"CERT Record" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CNAMERecord / $refAdded value: +"#/$defs/dns-records_CNAMERecord" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid hostname. Must not match the record's name.", - "type": "string" - }, - "settings": { - "properties": { - "flatten_cname": { - "default": false, - "description": "If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CNAME" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / titleRemoved value: -"CNAME Record" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / $refAdded value: +"#/$defs/dns-records_DNSKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", - "type": "string" - }, - "data": { - "description": "Components of a DNSKEY record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "flags": { - "description": "Flags.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "protocol": { - "description": "Protocol.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "public_key": { - "description": "Public Key.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DNSKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / titleRemoved value: -"DNSKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DSRecord / $refAdded value: +"#/$defs/dns-records_DSRecord" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DS content. See 'data' to set DS properties.", - "type": "string" - }, - "data": { - "description": "Components of a DS record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "digest": { - "description": "Digest.", - "type": "string" - }, - "digest_type": { - "description": "Digest Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / titleRemoved value: -"DS Record" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / $refAdded value: +"#/$defs/dns-records_HTTPSRecord" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", - "type": "string" - }, - "data": { - "description": "Components of a HTTPS record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "HTTPS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / titleRemoved value: -"HTTPS Record" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_LOCRecord / $refAdded value: +"#/$defs/dns-records_LOCRecord" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted LOC content. See 'data' to set LOC properties.", - "type": "string" - }, - "data": { - "description": "Components of a LOC record.", - "properties": { - "altitude": { - "description": "Altitude of location in meters.", - "maximum": 42849672.95, - "minimum": -100000, - "type": "number" - }, - "lat_degrees": { - "description": "Degrees of latitude.", - "maximum": 90, - "minimum": 0, - "type": "number" - }, - "lat_direction": { - "description": "Latitude direction.", - "enum": [ - "N", - "S" - ], - "type": "string" - }, - "lat_minutes": { - "description": "Minutes of latitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "lat_seconds": { - "description": "Seconds of latitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "long_degrees": { - "description": "Degrees of longitude.", - "maximum": 180, - "minimum": 0, - "type": "number" - }, - "long_direction": { - "description": "Longitude direction.", - "enum": [ - "E", - "W" - ], - "type": "string" - }, - "long_minutes": { - "description": "Minutes of longitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "long_seconds": { - "description": "Seconds of longitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "precision_horz": { - "description": "Horizontal precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "precision_vert": { - "description": "Vertical precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "size": { - "description": "Size of location in meters.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "LOC" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / titleRemoved value: -"LOC Record" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_MXRecord / $refAdded value: +"#/$defs/dns-records_MXRecord" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid mail server hostname.", - "format": "hostname", - "type": "string" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "MX" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / titleRemoved value: -"MX Record" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / $refAdded value: +"#/$defs/dns-records_NAPTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", - "type": "string" - }, - "data": { - "description": "Components of a NAPTR record.", - "properties": { - "flags": { - "description": "Flags.", - "type": "string" - }, - "order": { - "description": "Order.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "preference": { - "description": "Preference.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "regex": { - "description": "Regex.", - "type": "string" - }, - "replacement": { - "description": "Replacement.", - "type": "string" - }, - "service": { - "description": "Service.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "NAPTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / titleRemoved value: -"NAPTR Record" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NSRecord / $refAdded value: +"#/$defs/dns-records_NSRecord" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid name server host name.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "NS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / titleRemoved value: -"NS Record" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / $refAdded value: +"#/$defs/dns-records_OPENPGPKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "OPENPGPKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / titleRemoved value: -"OPENPGPKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_PTRRecord / $refAdded value: +"#/$defs/dns-records_PTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Domain name pointing to the address.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "PTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / titleRemoved value: -"PTR Record" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / $refAdded value: +"#/$defs/dns-records_SMIMEARecord" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", - "type": "string" - }, - "data": { - "description": "Components of a SMIMEA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SMIMEA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / titleRemoved value: -"SMIMEA Record" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SRVRecord / $refAdded value: +"#/$defs/dns-records_SRVRecord" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", - "type": "string" - }, - "data": { - "description": "Components of a SRV record.", - "properties": { - "port": { - "description": "The port of the service.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "target": { - "description": "A valid hostname.", - "format": "hostname", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SRV" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / titleRemoved value: -"SRV Record" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / $refAdded value: +"#/$defs/dns-records_SSHFPRecord" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", - "type": "string" - }, - "data": { - "description": "Components of a SSHFP record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "fingerprint": { - "description": "Fingerprint.", - "type": "string" - }, - "type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SSHFP" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / titleRemoved value: -"SSHFP Record" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SVCBRecord / $refAdded value: +"#/$defs/dns-records_SVCBRecord" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SVCB content. See 'data' to set SVCB properties.", - "type": "string" - }, - "data": { - "description": "Components of a SVCB record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SVCB" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / titleRemoved value: -"SVCB Record" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TLSARecord / $refAdded value: +"#/$defs/dns-records_TLSARecord" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted TLSA content. See 'data' to set TLSA properties.", - "type": "string" - }, - "data": { - "description": "Components of a TLSA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "TLSA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / titleRemoved value: -"TLSA Record" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TXTRecord / $refAdded value: +"#/$defs/dns-records_TXTRecord" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at <https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/>.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "TXT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / titleRemoved value: -"TXT Record" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_URIRecord / $refAdded value: +"#/$defs/dns-records_URIRecord" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted URI content. See 'data' to set URI properties.", - "type": "string" - }, - "data": { - "description": "Components of a URI record.", - "properties": { - "target": { - "description": "The record content.", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "URI" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / titleRemoved value: -"URI Record" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_comment / $refAdded value: +"#/$defs/dns-records_comment" - removed
Input schema / properties / payload / $defs / dns-records_comment / descriptionRemoved value: -"Comments or notes about the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_comment / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / $refAdded value: +"#/$defs/dns-records_dns-record-shared-fields" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / propertiesRemoved value: -{ - "comment": { - "$ref": "#/$defs/dns-records_comment" - }, - "name": { - "$ref": "#/$defs/dns-records_name" - }, - "proxied": { - "$ref": "#/$defs/dns-records_proxied" - }, - "settings": { - "$ref": "#/$defs/dns-records_settings" - }, - "tags": { - "$ref": "#/$defs/dns-records_tags" - }, - "ttl": { - "$ref": "#/$defs/dns-records_ttl" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / $refAdded value: +"#/$defs/dns-records_dns-record-with-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_CAARecord" - }, - { - "$ref": "#/$defs/dns-records_CERTRecord" - }, - { - "$ref": "#/$defs/dns-records_DNSKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_DSRecord" - }, - { - "$ref": "#/$defs/dns-records_HTTPSRecord" - }, - { - "$ref": "#/$defs/dns-records_LOCRecord" - }, - { - "$ref": "#/$defs/dns-records_NAPTRRecord" - }, - { - "$ref": "#/$defs/dns-records_SMIMEARecord" - }, - { - "$ref": "#/$defs/dns-records_SRVRecord" - }, - { - "$ref": "#/$defs/dns-records_SSHFPRecord" - }, - { - "$ref": "#/$defs/dns-records_SVCBRecord" - }, - { - "$ref": "#/$defs/dns-records_TLSARecord" - }, - { - "$ref": "#/$defs/dns-records_URIRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / $refAdded value: +"#/$defs/dns-records_dns-record-without-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_ARecord" - }, - { - "$ref": "#/$defs/dns-records_AAAARecord" - }, - { - "$ref": "#/$defs/dns-records_CNAMERecord" - }, - { - "$ref": "#/$defs/dns-records_MXRecord" - }, - { - "$ref": "#/$defs/dns-records_NSRecord" - }, - { - "$ref": "#/$defs/dns-records_OPENPGPKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_PTRRecord" - }, - { - "$ref": "#/$defs/dns-records_TXTRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_identifier / $refAdded value: +"#/$defs/dns-records_identifier" - removed
Input schema / properties / payload / $defs / dns-records_identifier / descriptionRemoved value: -"Identifier." - removed
Input schema / properties / payload / $defs / dns-records_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / dns-records_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_name / $refAdded value: +"#/$defs/dns-records_name" - removed
Input schema / properties / payload / $defs / dns-records_name / descriptionRemoved value: -"Complete DNS record name, including the zone name, in Punycode." - removed
Input schema / properties / payload / $defs / dns-records_name / maxLengthRemoved value: -255 - removed
Input schema / properties / payload / $defs / dns-records_name / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_priority / $refAdded value: +"#/$defs/dns-records_priority" - removed
Input schema / properties / payload / $defs / dns-records_priority / descriptionRemoved value: -"Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map." - removed
Input schema / properties / payload / $defs / dns-records_priority / maximumRemoved value: -65535 - removed
Input schema / properties / payload / $defs / dns-records_priority / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / dns-records_priority / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / dns-records_proxied / $refAdded value: +"#/$defs/dns-records_proxied" - removed
Input schema / properties / payload / $defs / dns-records_proxied / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / dns-records_proxied / descriptionRemoved value: -"Whether the record is receiving the performance and security benefits of Cloudflare." - removed
Input schema / properties / payload / $defs / dns-records_proxied / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / dns-records_settings / $refAdded value: +"#/$defs/dns-records_settings" - removed
Input schema / properties / payload / $defs / dns-records_settings / descriptionRemoved value: -"Settings for the DNS record." - removed
Input schema / properties / payload / $defs / dns-records_settings / propertiesRemoved value: -{ - "ipv4_only": { - "default": false, - "description": "When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - }, - "ipv6_only": { - "default": false, - "description": "When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / dns-records_settings / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_tags / $refAdded value: +"#/$defs/dns-records_tags" - removed
Input schema / properties / payload / $defs / dns-records_tags / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / dns-records_tags / descriptionRemoved value: -"Custom tags for the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_tags / itemsRemoved value: -{ - "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", - "type": "string" -} - removed
Input schema / properties / payload / $defs / dns-records_tags / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / dns-records_ttl / $refAdded value: +"#/$defs/dns-records_ttl" - removed
Input schema / properties / payload / $defs / dns-records_ttl / anyOfRemoved value: -[ - { - "maximum": 86400, - "minimum": 30, - "type": "number" - }, - { - "enum": [ - 1 - ], - "type": "number" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ttl / defaultRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_ttl / descriptionRemoved value: -"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones." - removed
Input schema / properties / payload / $defs / dns-records_ttl / typeRemoved value: -"number"
- Changed
create_zone_ruleset503 fields changed- added
Input schema / $defs / Remove_DirectiveAdded value: +{ + "description": "Remove the directive.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "remove" + ], + "type": "string" + } + ] + } + }, + "required": [ + "operation" + ], + "title": "Remove Directive", + "type": "object" +} - changed
Input schema / $defs / rulesets_SetCacheControlDirective / oneOfPrevious value: -[ - { - "description": "Set the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -]New value: +[ + { + "description": "Set the directive.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "set" + ], + "type": "string" + } + ] + } + }, + "required": [ + "operation" + ], + "title": "Set Directive", + "type": "object" + }, + { + "$ref": "#/$defs/Remove_Directive" + } +] - changed
Input schema / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / oneOfPrevious value: -[ - { - "description": "Set the directive with optional qualifiers.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "qualifiers": { - "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).", - "items": { - "description": "A header name to qualify the directive.", - "minLength": 1, - "title": "Qualifier", - "type": "string" - }, - "title": "Qualifiers", - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -]New value: +[ + { + "description": "Set the directive with optional qualifiers.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "set" + ], + "type": "string" + } + ] + }, + "qualifiers": { + "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).", + "items": { + "description": "A header name to qualify the directive.", + "minLength": 1, + "title": "Qualifier", + "type": "string" + }, + "title": "Qualifiers", + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "operation" + ], + "title": "Set Directive", + "type": "object" + }, + { + "$ref": "#/$defs/Remove_Directive" + } +] - changed
Input schema / $defs / rulesets_SetCacheControlDirectiveWithValue / oneOfPrevious value: -[ - { - "description": "Set the directive with a duration value in seconds.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "value": { - "description": "The duration value in seconds for the directive.", - "minimum": 0, - "title": "Value", - "type": "integer" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -]New value: +[ + { + "description": "Set the directive with a duration value in seconds.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "set" + ], + "type": "string" + } + ] + }, + "value": { + "description": "The duration value in seconds for the directive.", + "minimum": 0, + "title": "Value", + "type": "integer" + } + }, + "required": [ + "operation", + "value" + ], + "title": "Set Directive", + "type": "object" + }, + { + "$ref": "#/$defs/Remove_Directive" + } +] - changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / rulesets_BlockRule / $refAdded value: +"#/$defs/rulesets_BlockRule" - removed
Input schema / properties / payload / $defs / rulesets_BlockRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "block" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "response": { - "description": "The response to show when the block is applied.", - "properties": { - "content": { - "description": "The content to return.", - "minLength": 1, - "title": "Content", - "type": "string" - }, - "content_type": { - "description": "The type of the content to return.", - "minLength": 1, - "title": "Content Type", - "type": "string" - }, - "status_code": { - "description": "The status code to return.", - "maximum": 499, - "minimum": 400, - "title": "Status Code", - "type": "integer" - } - }, - "required": [ - "status_code", - "content", - "content_type" - ], - "title": "Response", - "type": "object" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Block Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ChallengeRule / $refAdded value: +"#/$defs/rulesets_ChallengeRule" - removed
Input schema / properties / payload / $defs / rulesets_ChallengeRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "challenge" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Challenge Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_CompressResponseRule / $refAdded value: +"#/$defs/rulesets_CompressResponseRule" - removed
Input schema / properties / payload / $defs / rulesets_CompressResponseRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "compress_response" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "algorithms": { - "description": "Custom order for compression algorithms.", - "items": { - "description": "Compression algorithm to enable.", - "properties": { - "name": { - "description": "Name of the compression algorithm to enable.", - "enum": [ - "none", - "auto", - "default", - "gzip", - "brotli", - "zstd" - ], - "title": "Algorithm Name", - "type": "string" - } - }, - "title": "Algorithm", - "type": "object" - }, - "minItems": 1, - "title": "Algorithms", - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "algorithms" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Response Compression Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_DDoSDynamicRule / $refAdded value: +"#/$defs/rulesets_DDoSDynamicRule" - removed
Input schema / properties / payload / $defs / rulesets_DDoSDynamicRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "ddos_dynamic" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "DDoS Dynamic Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / $refAdded value: +"#/$defs/rulesets_ExecuteCategoryOverrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / descriptionRemoved value: -"A list of category-level overrides. This option has the second-highest precedence after rule-level overrides." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / itemsRemoved value: -{ - "description": "A category-level override.", - "minProperties": 2, - "properties": { - "action": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleAction" - }, - { - "description": "The action to override rules in the category with.", - "type": "string" - } - ] - }, - "category": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleCategory" - }, - { - "description": "The name of the category to override.", - "type": "string" - } - ] - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "description": "Whether to enable execution of rules in the category.", - "type": "boolean" - } - ] - }, - "sensitivity_level": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel" - }, - { - "description": "The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases.", - "type": "string" - } - ] - } - }, - "required": [ - "category" - ], - "title": "Category Override", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / titleRemoved value: -"Category Overrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / $refAdded value: +"#/$defs/rulesets_ExecuteMatchedData" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / descriptionRemoved value: -"The configuration to use for matched data logging." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / propertiesRemoved value: -{ - "public_key": { - "description": "The public key to encrypt matched data logs with.", - "minLength": 1, - "title": "Public Key", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / requiredRemoved value: -[ - "public_key" -] - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / titleRemoved value: -"Matched Data" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / $refAdded value: +"#/$defs/rulesets_ExecuteOverrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / descriptionRemoved value: -"A set of overrides to apply to the target ruleset." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / propertiesRemoved value: -{ - "action": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleAction" - }, - { - "description": "An action to override all rules with. This option has lower precedence than rule and category overrides.", - "type": "string" - } - ] - }, - "categories": { - "$ref": "#/$defs/rulesets_ExecuteCategoryOverrides" - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "description": "Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.", - "type": "boolean" - } - ] - }, - "rules": { - "$ref": "#/$defs/rulesets_ExecuteRuleOverrides" - }, - "sensitivity_level": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel" - }, - { - "description": "A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.", - "type": "string" - } - ] - } -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / titleRemoved value: -"Overrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_ExecuteRule / $refAdded value: +"#/$defs/rulesets_ExecuteRule" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "execute" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "id": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetId" - }, - { - "description": "The ID of the ruleset to execute.", - "type": "string" - } - ] - }, - "matched_data": { - "$ref": "#/$defs/rulesets_ExecuteMatchedData" - }, - "overrides": { - "$ref": "#/$defs/rulesets_ExecuteOverrides" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Execute Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / $refAdded value: +"#/$defs/rulesets_ExecuteRuleOverrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / descriptionRemoved value: -"A list of rule-level overrides. This option has the highest precedence." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / itemsRemoved value: -{ - "description": "A rule-level override.", - "minProperties": 2, - "properties": { - "action": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleAction" - }, - { - "description": "The action to override the rule with.", - "type": "string" - } - ] - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "description": "Whether to enable execution of the rule.", - "type": "boolean" - } - ] - }, - "id": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleId" - }, - { - "description": "The ID of the rule to override.", - "type": "string" - } - ] - }, - "score_threshold": { - "description": "The score threshold to use for the rule.", - "title": "Score Threshold", - "type": "integer" - }, - "sensitivity_level": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel" - }, - { - "description": "The sensitivity level to use for the rule. This option is only applicable for DDoS phases.", - "type": "string" - } - ] - } - }, - "required": [ - "id" - ], - "title": "Rule Override", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / titleRemoved value: -"Rule Overrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / $refAdded value: +"#/$defs/rulesets_ExecuteSensitivityLevel" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / enumRemoved value: -[ - "default", - "medium", - "low", - "eoff" -] - removed
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / titleRemoved value: -"Sensitivity Level" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ForceConnectionCloseRule / $refAdded value: +"#/$defs/rulesets_ForceConnectionCloseRule" - removed
Input schema / properties / payload / $defs / rulesets_ForceConnectionCloseRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "force_connection_close" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Force Connection Close Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_JsChallengeRule / $refAdded value: +"#/$defs/rulesets_JsChallengeRule" - removed
Input schema / properties / payload / $defs / rulesets_JsChallengeRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "js_challenge" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "JavaScript Challenge Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldCookieFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / descriptionRemoved value: -"The cookie fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / itemsRemoved value: -{ - "description": "The cookie field to log.", - "properties": { - "name": { - "description": "The name of the cookie.", - "minLength": 1, - "title": "Cookie Name", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "Cookie Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / titleRemoved value: -"Cookie Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldRawResponseFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / descriptionRemoved value: -"The raw response fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / itemsRemoved value: -{ - "description": "The raw response field to log.", - "properties": { - "name": { - "description": "The name of the response header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - }, - "preserve_duplicates": { - "default": false, - "description": "Whether to log duplicate values of the same header.", - "title": "Preserve Duplicates", - "type": "boolean" - } - }, - "required": [ - "name" - ], - "title": "Raw Response Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / titleRemoved value: -"Raw Response Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldRequestFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / descriptionRemoved value: -"The raw request fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / itemsRemoved value: -{ - "description": "The raw request field to log.", - "properties": { - "name": { - "description": "The name of the header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "Raw Request Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / titleRemoved value: -"Raw Request Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldResponseFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / descriptionRemoved value: -"The transformed response fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / itemsRemoved value: -{ - "description": "The transformed response field to log.", - "properties": { - "name": { - "description": "The name of the response header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - }, - "preserve_duplicates": { - "default": false, - "description": "Whether to log duplicate values of the same header.", - "title": "Preserve Duplicates", - "type": "boolean" - } - }, - "required": [ - "name" - ], - "title": "Transformed Response Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / titleRemoved value: -"Transformed Response Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRule / $refAdded value: +"#/$defs/rulesets_LogCustomFieldRule" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "log_custom_field" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "cookie_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldCookieFields" - }, - "raw_response_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldRawResponseFields" - }, - "request_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldRequestFields" - }, - "response_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldResponseFields" - }, - "transformed_request_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldTransformedRequestFields" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Log Custom Field Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldTransformedRequestFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / descriptionRemoved value: -"The transformed request fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / itemsRemoved value: -{ - "description": "The transformed request field to log.", - "properties": { - "name": { - "description": "The name of the header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "Transformed Request Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / titleRemoved value: -"Transformed Request Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogRule / $refAdded value: +"#/$defs/rulesets_LogRule" - removed
Input schema / properties / payload / $defs / rulesets_LogRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "log" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Log Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ManagedChallengeRule / $refAdded value: +"#/$defs/rulesets_ManagedChallengeRule" - removed
Input schema / properties / payload / $defs / rulesets_ManagedChallengeRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "managed_challenge" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Managed Challenge Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RedirectFromList / $refAdded value: +"#/$defs/rulesets_RedirectFromList" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / descriptionRemoved value: -"A redirect based on a bulk list lookup." - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / propertiesRemoved value: -{ - "key": { - "description": "An expression that evaluates to the list lookup key.", - "minLength": 1, - "title": "Lookup Key", - "type": "string" - }, - "name": { - "description": "The name of the list to match against.", - "pattern": "^[a-zA-Z0-9_]+$", - "title": "List Name", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / requiredRemoved value: -[ - "name", - "key" -] - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / titleRemoved value: -"Bulk Redirect" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / $refAdded value: +"#/$defs/rulesets_RedirectFromValue" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / descriptionRemoved value: -"A redirect based on the request properties." - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / propertiesRemoved value: -{ - "preserve_query_string": { - "default": false, - "description": "Whether to keep the query string of the original request.", - "title": "Preserve Query String", - "type": "boolean" - }, - "status_code": { - "description": "The status code to use for the redirect.", - "enum": [ - 301, - 302, - 303, - 307, - 308 - ], - "title": "Status Code", - "type": "integer" - }, - "target_url": { - "description": "A URL to redirect the request to.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "expression": { - "description": "An expression that evaluates to a URL to redirect the request to.", - "minLength": 1, - "title": "Redirect Expression", - "type": "string" - }, - "value": { - "description": "A URL to redirect the request to.", - "minLength": 1, - "title": "Redirect Value", - "type": "string" - } - }, - "title": "Target URL", - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / requiredRemoved value: -[ - "target_url" -] - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / titleRemoved value: -"Single Redirect" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RedirectRule / $refAdded value: +"#/$defs/rulesets_RedirectRule" - removed
Input schema / properties / payload / $defs / rulesets_RedirectRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "redirect" - ], - "type": "string" - }, - "action_parameters": { - "maxProperties": 1, - "minProperties": 1, - "properties": { - "from_list": { - "$ref": "#/$defs/rulesets_RedirectFromList" - }, - "from_value": { - "$ref": "#/$defs/rulesets_RedirectFromValue" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Redirect Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RequestRule / $refAdded value: +"#/$defs/rulesets_RequestRule" - removed
Input schema / properties / payload / $defs / rulesets_RequestRule / oneOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_BlockRule" - }, - { - "$ref": "#/$defs/rulesets_ChallengeRule" - }, - { - "$ref": "#/$defs/rulesets_CompressResponseRule" - }, - { - "$ref": "#/$defs/rulesets_DDoSDynamicRule" - }, - { - "$ref": "#/$defs/rulesets_ExecuteRule" - }, - { - "$ref": "#/$defs/rulesets_ForceConnectionCloseRule" - }, - { - "$ref": "#/$defs/rulesets_JsChallengeRule" - }, - { - "$ref": "#/$defs/rulesets_LogRule" - }, - { - "$ref": "#/$defs/rulesets_LogCustomFieldRule" - }, - { - "$ref": "#/$defs/rulesets_ManagedChallengeRule" - }, - { - "$ref": "#/$defs/rulesets_RedirectRule" - }, - { - "$ref": "#/$defs/rulesets_RewriteRule" - }, - { - "$ref": "#/$defs/rulesets_RouteRule" - }, - { - "$ref": "#/$defs/rulesets_ScoreRule" - }, - { - "$ref": "#/$defs/rulesets_ServeErrorRule" - }, - { - "$ref": "#/$defs/rulesets_SetCacheControlRule" - }, - { - "$ref": "#/$defs/rulesets_SetCacheSettingsRule" - }, - { - "$ref": "#/$defs/rulesets_SetCacheTagsRule" - }, - { - "$ref": "#/$defs/rulesets_SetConfigRule" - }, - { - "$ref": "#/$defs/rulesets_SkipRule" - }, - { - "$ref": "#/$defs/rulesets_TransformResponseHTMLRule" - } -] - added
Input schema / properties / payload / $defs / rulesets_RequestRules / $refAdded value: +"#/$defs/rulesets_RequestRules" - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / descriptionRemoved value: -"The list of rules in the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / itemsRemoved value: -{ - "$ref": "#/$defs/rulesets_RequestRule" -} - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / titleRemoved value: -"Rules" - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / $refAdded value: +"#/$defs/rulesets_RewriteHeaderExpression" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / descriptionRemoved value: -"An expression that evaluates to a value for the header." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / titleRemoved value: -"Header Expression" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / $refAdded value: +"#/$defs/rulesets_RewriteHeaderOperation" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / descriptionRemoved value: -"The operation to perform on the header." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / titleRemoved value: -"Operation" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / $refAdded value: +"#/$defs/rulesets_RewriteHeaderValue" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / descriptionRemoved value: -"A static value for the header." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / titleRemoved value: -"Header Value" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / $refAdded value: +"#/$defs/rulesets_RewriteHeaders" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / additionalPropertiesRemoved value: -{ - "oneOf": [ - { - "description": "A header with a static value to add.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - }, - "value": { - "$ref": "#/$defs/rulesets_RewriteHeaderValue" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Add Static Header", - "type": "object" - }, - { - "description": "A header with a dynamic value to add.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_RewriteHeaderExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Add Dynamic Header", - "type": "object" - }, - { - "description": "A header with a static value to set.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "value": { - "$ref": "#/$defs/rulesets_RewriteHeaderValue" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Set Static Header", - "type": "object" - }, - { - "description": "A header with a dynamic value to set.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_RewriteHeaderExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Set Dynamic Header", - "type": "object" - }, - { - "description": "A header to remove.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Header", - "type": "object" - } - ] -} - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / descriptionRemoved value: -"A map of headers to rewrite." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / titleRemoved value: -"Headers" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RewriteRule / $refAdded value: +"#/$defs/rulesets_RewriteRule" - removed
Input schema / properties / payload / $defs / rulesets_RewriteRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "rewrite" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "headers": { - "$ref": "#/$defs/rulesets_RewriteHeaders" - }, - "uri": { - "$ref": "#/$defs/rulesets_RewriteUri" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Rewrite Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RewriteUri / $refAdded value: +"#/$defs/rulesets_RewriteUri" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUri / allOfRemoved value: -[ - { - "anyOf": [ - { - "description": "A URI path rewrite.", - "properties": { - "path": { - "$ref": "#/$defs/rulesets_RewriteUriPath" - } - }, - "required": [ - "path" - ], - "title": "URI Path", - "type": "object" - }, - { - "description": "A URI query rewrite.", - "properties": { - "query": { - "$ref": "#/$defs/rulesets_RewriteUriQuery" - } - }, - "required": [ - "query" - ], - "title": "URI Query", - "type": "object" - } - ] - }, - { - "properties": { - "origin": { - "description": "Whether to propagate the rewritten URI to origin.", - "title": "Origin", - "type": "boolean" - } - }, - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / $refAdded value: +"#/$defs/rulesets_RewriteUriPath" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / descriptionRemoved value: -"A URI path rewrite." - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / maxPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / propertiesRemoved value: -{ - "expression": { - "description": "An expression that evaluates to a value to rewrite the URI path to.", - "minLength": 1, - "title": "Path Expression", - "type": "string" - }, - "value": { - "description": "A value to rewrite the URI path to.", - "minLength": 1, - "title": "Path Value", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / titleRemoved value: -"URI Path" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / $refAdded value: +"#/$defs/rulesets_RewriteUriQuery" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / descriptionRemoved value: -"A URI query rewrite." - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / maxPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / propertiesRemoved value: -{ - "expression": { - "description": "An expression that evaluates to a value to rewrite the URI query to.", - "minLength": 1, - "title": "Query Expression", - "type": "string" - }, - "value": { - "description": "A value to rewrite the URI query to.", - "title": "Query Value", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / titleRemoved value: -"URI Query" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / $refAdded value: +"#/$defs/rulesets_RouteHostHeader" - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / descriptionRemoved value: -"A value to rewrite the HTTP host header to." - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / titleRemoved value: -"Host Header" - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RouteOrigin / $refAdded value: +"#/$defs/rulesets_RouteOrigin" - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / descriptionRemoved value: -"An origin to route to." - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / propertiesRemoved value: -{ - "host": { - "description": "A resolved host to route to.", - "minLength": 1, - "title": "Host", - "type": "string" - }, - "port": { - "description": "A destination port to route to.", - "maximum": 65535, - "minimum": 1, - "title": "Port", - "type": "integer" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / titleRemoved value: -"Origin" - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RouteRule / $refAdded value: +"#/$defs/rulesets_RouteRule" - removed
Input schema / properties / payload / $defs / rulesets_RouteRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "route" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "host_header": { - "$ref": "#/$defs/rulesets_RouteHostHeader" - }, - "origin": { - "$ref": "#/$defs/rulesets_RouteOrigin" - }, - "sni": { - "$ref": "#/$defs/rulesets_RouteSNI" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Route Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RouteSNI / $refAdded value: +"#/$defs/rulesets_RouteSNI" - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / descriptionRemoved value: -"A Server Name Indication (SNI) override." - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / propertiesRemoved value: -{ - "value": { - "description": "A value to override the SNI to.", - "minLength": 1, - "title": "Value", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / requiredRemoved value: -[ - "value" -] - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / titleRemoved value: -"Server Name Indication" - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_Rule / $refAdded value: +"#/$defs/rulesets_Rule" - removed
Input schema / properties / payload / $defs / rulesets_Rule / propertiesRemoved value: -{ - "action": { - "$ref": "#/$defs/rulesets_RuleAction" - }, - "action_parameters": { - "default": {}, - "description": "The parameters configuring the rule's action.", - "title": "Action Parameters", - "type": "object" - }, - "categories": { - "$ref": "#/$defs/rulesets_RuleCategories" - }, - "description": { - "default": "", - "description": "An informative description of the rule.", - "title": "Description", - "type": "string" - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "default": true, - "type": "boolean" - } - ] - }, - "exposed_credential_check": { - "$ref": "#/$defs/rulesets_RuleExposedCredentialCheck" - }, - "expression": { - "description": "The expression defining which traffic will match the rule.", - "minLength": 1, - "title": "Expression", - "type": "string" - }, - "id": { - "$ref": "#/$defs/rulesets_RuleId" - }, - "last_updated": { - "description": "The timestamp of when the rule was last modified.", - "format": "date-time", - "title": "Last Updated", - "type": "string" - }, - "logging": { - "$ref": "#/$defs/rulesets_RuleLogging" - }, - "ratelimit": { - "$ref": "#/$defs/rulesets_RuleRatelimit" - }, - "ref": { - "description": "The reference of the rule (the rule's ID by default).", - "minLength": 1, - "title": "Ref", - "type": "string" - }, - "version": { - "description": "The version of the rule.", - "pattern": "^[0-9]+$", - "title": "Version", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_Rule / requiredRemoved value: -[ - "version", - "last_updated" -] - removed
Input schema / properties / payload / $defs / rulesets_Rule / titleRemoved value: -"Rule" - removed
Input schema / properties / payload / $defs / rulesets_Rule / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RuleAction / $refAdded value: +"#/$defs/rulesets_RuleAction" - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / descriptionRemoved value: -"The action to perform when the rule matches." - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / patternRemoved value: -"^[a-z_]+$" - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / titleRemoved value: -"Action" - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RuleCategories / $refAdded value: +"#/$defs/rulesets_RuleCategories" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / descriptionRemoved value: -"The categories of the rule." - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / itemsRemoved value: -{ - "$ref": "#/$defs/rulesets_RuleCategory" -} - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / titleRemoved value: -"Categories" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_RuleCategory / $refAdded value: +"#/$defs/rulesets_RuleCategory" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / descriptionRemoved value: -"The category of a rule." - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / titleRemoved value: -"Category" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RuleEnabled / $refAdded value: +"#/$defs/rulesets_RuleEnabled" - removed
Input schema / properties / payload / $defs / rulesets_RuleEnabled / descriptionRemoved value: -"Whether the rule should be executed." - removed
Input schema / properties / payload / $defs / rulesets_RuleEnabled / titleRemoved value: -"Enabled" - removed
Input schema / properties / payload / $defs / rulesets_RuleEnabled / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / $refAdded value: +"#/$defs/rulesets_RuleExposedCredentialCheck" - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / descriptionRemoved value: -"Configuration for exposed credential checking." - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / propertiesRemoved value: -{ - "password_expression": { - "description": "An expression that selects the password used in the credentials check.", - "minLength": 1, - "title": "Password Expression", - "type": "string" - }, - "username_expression": { - "description": "An expression that selects the user ID used in the credentials check.", - "minLength": 1, - "title": "Username Expression", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / requiredRemoved value: -[ - "username_expression", - "password_expression" -] - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / titleRemoved value: -"Exposed Credential Check" - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RuleId / $refAdded value: +"#/$defs/rulesets_RuleId" - removed
Input schema / properties / payload / $defs / rulesets_RuleId / descriptionRemoved value: -"The unique ID of the rule." - removed
Input schema / properties / payload / $defs / rulesets_RuleId / patternRemoved value: -"^[0-9a-f]{32}$" - removed
Input schema / properties / payload / $defs / rulesets_RuleId / titleRemoved value: -"Rule ID" - removed
Input schema / properties / payload / $defs / rulesets_RuleId / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RuleLogging / $refAdded value: +"#/$defs/rulesets_RuleLogging" - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / descriptionRemoved value: -"An object configuring the rule's logging behavior." - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / propertiesRemoved value: -{ - "enabled": { - "description": "Whether to generate a log when the rule matches.", - "title": "Enabled", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / requiredRemoved value: -[ - "enabled" -] - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / titleRemoved value: -"Logging" - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / $refAdded value: +"#/$defs/rulesets_RuleRatelimit" - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / descriptionRemoved value: -"An object configuring the rule's rate limit behavior." - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / propertiesRemoved value: -{ - "characteristics": { - "description": "Characteristics of the request on which the rate limit counter will be incremented.", - "items": { - "description": "The characteristic of the request.", - "minLength": 1, - "title": "Characteristic", - "type": "string" - }, - "minItems": 1, - "title": "Characteristics", - "type": "array", - "uniqueItems": true - }, - "counting_expression": { - "description": "An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.", - "minLength": 1, - "title": "Counting Expression", - "type": "string" - }, - "mitigation_timeout": { - "description": "Period of time in seconds after which the action will be disabled following its first execution.", - "title": "Mitigation Timeout", - "type": "integer" - }, - "period": { - "description": "Period in seconds over which the counter is being incremented.", - "minimum": 0, - "title": "Period", - "type": "integer" - }, - "requests_per_period": { - "description": "The threshold of requests per period after which the action will be executed for the first time.", - "minimum": 1, - "title": "Requests per Period", - "type": "integer" - }, - "requests_to_origin": { - "default": false, - "description": "Whether counting is only performed when an origin is reached.", - "title": "Requests to Origin", - "type": "boolean" - }, - "score_per_period": { - "description": "The score threshold per period for which the action will be executed the first time.", - "title": "Score per Period", - "type": "integer" - }, - "score_response_header_name": { - "description": "A response header name provided by the origin, which contains the score to increment rate limit counter with.", - "minLength": 1, - "title": "Score Response Header Name", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / requiredRemoved value: -[ - "characteristics", - "period" -] - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / titleRemoved value: -"Rate Limit" - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_Ruleset / $refAdded value: +"#/$defs/rulesets_Ruleset" - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / descriptionRemoved value: -"A ruleset object." - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / propertiesRemoved value: -{ - "description": { - "default": "", - "description": "An informative description of the ruleset.", - "title": "Description", - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetId" - }, - { - "type": "string" - } - ] - }, - "last_updated": { - "description": "The timestamp of when the ruleset was last modified.", - "format": "date-time", - "title": "Last Updated", - "type": "string" - }, - "name": { - "description": "The human-readable name of the ruleset.", - "minLength": 1, - "title": "Name", - "type": "string" - }, - "version": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetVersion" - }, - { - "type": "string" - } - ] - } -} - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / requiredRemoved value: -[ - "id", - "version", - "last_updated" -] - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / titleRemoved value: -"Ruleset" - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RulesetId / $refAdded value: +"#/$defs/rulesets_RulesetId" - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / descriptionRemoved value: -"The unique ID of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / patternRemoved value: -"^[0-9a-f]{32}$" - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / titleRemoved value: -"Ruleset ID" - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RulesetKind / $refAdded value: +"#/$defs/rulesets_RulesetKind" - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / descriptionRemoved value: -"The kind of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / enumRemoved value: -[ - "managed", - "custom", - "root", - "zone" -] - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / titleRemoved value: -"Kind" - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RulesetPhase / $refAdded value: +"#/$defs/rulesets_RulesetPhase" - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / descriptionRemoved value: -"The phase of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / enumRemoved value: -[ - "ddos_l4", - "ddos_l7", - "http_config_settings", - "http_custom_errors", - "http_log_custom_fields", - "http_ratelimit", - "http_request_cache_settings", - "http_request_dynamic_redirect", - "http_request_firewall_custom", - "http_request_firewall_managed", - "http_request_late_transform", - "http_request_origin", - "http_request_redirect", - "http_request_sanitize", - "http_request_sbfm", - "http_request_transform", - "http_response_cache_settings", - "http_response_compression", - "http_response_firewall_managed", - "http_response_headers_transform", - "magic_transit", - "magic_transit_ids_managed", - "magic_transit_managed", - "magic_transit_ratelimit" -] - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / titleRemoved value: -"Phase" - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RulesetVersion / $refAdded value: +"#/$defs/rulesets_RulesetVersion" - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / descriptionRemoved value: -"The version of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / patternRemoved value: -"^[0-9]+$" - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / titleRemoved value: -"Version" - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / $refAdded value: +"#/$defs/rulesets_ScoreIncrement" - removed
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / descriptionRemoved value: -"A delta to change the score by, which can be either positive or negative." - removed
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / titleRemoved value: -"Increment" - removed
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / rulesets_ScoreRule / $refAdded value: +"#/$defs/rulesets_ScoreRule" - removed
Input schema / properties / payload / $defs / rulesets_ScoreRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "score" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "increment": { - "$ref": "#/$defs/rulesets_ScoreIncrement" - } - }, - "required": [ - "increment" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Score Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / $refAdded value: +"#/$defs/rulesets_ServeErrorAssetName" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / descriptionRemoved value: -"The name of a custom asset to serve as the error response." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / titleRemoved value: -"Asset Name" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / $refAdded value: +"#/$defs/rulesets_ServeErrorContent" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / descriptionRemoved value: -"The response content." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / titleRemoved value: -"Content" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / $refAdded value: +"#/$defs/rulesets_ServeErrorContentType" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / descriptionRemoved value: -"The content type header to set with the error response." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / enumRemoved value: -[ - "application/json", - "text/html", - "text/plain", - "text/xml" -] - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / titleRemoved value: -"Content Type" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ServeErrorRule / $refAdded value: +"#/$defs/rulesets_ServeErrorRule" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "serve_error" - ], - "type": "string" - }, - "action_parameters": { - "allOf": [ - { - "properties": { - "content_type": { - "$ref": "#/$defs/rulesets_ServeErrorContentType" - }, - "status_code": { - "$ref": "#/$defs/rulesets_ServeErrorStatusCode" - } - }, - "required": [ - "content_type" - ], - "type": "object" - }, - { - "oneOf": [ - { - "properties": { - "content": { - "$ref": "#/$defs/rulesets_ServeErrorContent" - } - }, - "required": [ - "content" - ], - "title": "Action Parameters (Content)", - "type": "object" - }, - { - "properties": { - "asset_name": { - "$ref": "#/$defs/rulesets_ServeErrorAssetName" - } - }, - "required": [ - "asset_name" - ], - "title": "Action Parameters (Asset)", - "type": "object" - } - ] - } - ] - }, - "description": { - "type": "string" - } - }, - "title": "Serve Error Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / $refAdded value: +"#/$defs/rulesets_ServeErrorStatusCode" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / descriptionRemoved value: -"The status code to use for the error." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / maximumRemoved value: -999 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / minimumRemoved value: -400 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / titleRemoved value: -"Status Code" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / $refAdded value: +"#/$defs/rulesets_SetCacheControlCloudflareOnly" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / descriptionRemoved value: -"Whether the directive should only be applied to the Cloudflare CDN cache." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / titleRemoved value: -"Cloudflare Only" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / $refAdded value: +"#/$defs/rulesets_SetCacheControlDirective" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / descriptionRemoved value: -"A cache-control directive configuration." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / oneOfRemoved value: -[ - { - "description": "Set the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / titleRemoved value: -"Cache Control Directive" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / $refAdded value: +"#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / descriptionRemoved value: -"A cache-control directive configuration that accepts optional qualifiers (header names)." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / oneOfRemoved value: -[ - { - "description": "Set the directive with optional qualifiers.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "qualifiers": { - "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).", - "items": { - "description": "A header name to qualify the directive.", - "minLength": 1, - "title": "Qualifier", - "type": "string" - }, - "title": "Qualifiers", - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / titleRemoved value: -"Cache Control Directive With Optional Qualifiers" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / $refAdded value: +"#/$defs/rulesets_SetCacheControlDirectiveWithValue" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / descriptionRemoved value: -"A cache-control directive configuration that accepts a duration value in seconds." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / oneOfRemoved value: -[ - { - "description": "Set the directive with a duration value in seconds.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "value": { - "description": "The duration value in seconds for the directive.", - "minimum": 0, - "title": "Value", - "type": "integer" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / titleRemoved value: -"Cache Control Directive With Duration Seconds Value" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / $refAdded value: +"#/$defs/rulesets_SetCacheControlOperation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / descriptionRemoved value: -"The operation to perform on the cache-control directive." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / enumRemoved value: -[ - "set", - "remove" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / titleRemoved value: -"Operation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlRule / $refAdded value: +"#/$defs/rulesets_SetCacheControlRule" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_cache_control" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "immutable": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "max-age": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - }, - "must-revalidate": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "must-understand": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "no-cache": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers" - }, - "no-store": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "no-transform": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "private": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers" - }, - "proxy-revalidate": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "public": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "s-maxage": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - }, - "stale-if-error": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - }, - "stale-while-revalidate": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Set Cache Control Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsAdditionalCacheablePorts" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / descriptionRemoved value: -"A list of additional ports that caching should be enabled on." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / itemsRemoved value: -{ - "description": "A port to enable caching on.", - "maximum": 65535, - "minimum": 1, - "title": "Additional Cacheable Port", - "type": "integer" -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / titleRemoved value: -"Additional Cacheable Ports (Enterprise-Only)" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsBrowserTTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / descriptionRemoved value: -"How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / propertiesRemoved value: -{ - "default": { - "description": "The browser TTL (in seconds) if you choose the \"override_origin\" mode.", - "minimum": 0, - "title": "Default TTL", - "type": "integer" - }, - "mode": { - "description": "The browser TTL mode.", - "enum": [ - "respect_origin", - "bypass_by_default", - "override_origin", - "bypass" - ], - "title": "TTL Mode", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / requiredRemoved value: -[ - "mode" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / titleRemoved value: -"Browser TTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCache" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / descriptionRemoved value: -"Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / titleRemoved value: -"Cache" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCacheKey" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / descriptionRemoved value: -"Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / propertiesRemoved value: -{ - "cache_by_device_type": { - "description": "Whether to separate cached content based on the visitor's device type.", - "title": "Cache by Device Type", - "type": "boolean" - }, - "cache_deception_armor": { - "description": "Whether to protect from web cache deception attacks, while allowing static assets to be cached.", - "title": "Cache Deception Armor", - "type": "boolean" - }, - "custom_key": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKey" - }, - "ignore_query_strings_order": { - "description": "Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.", - "title": "Ignore Query Strings Order", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / titleRemoved value: -"Cache Key" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCacheReserve" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / descriptionRemoved value: -"Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan)." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / propertiesRemoved value: -{ - "eligible": { - "description": "Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.", - "title": "Eligible", - "type": "boolean" - }, - "minimum_file_size": { - "description": "The minimum file size eligible for storage in Cache Reserve.", - "minimum": 0, - "title": "Minimum File Size", - "type": "integer" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / requiredRemoved value: -[ - "eligible" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / titleRemoved value: -"Cache Reserve" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKey" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / descriptionRemoved value: -"Which components of the request are included or excluded from the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / propertiesRemoved value: -{ - "cookie": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyCookie" - }, - "header": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHeader" - }, - "host": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHost" - }, - "query_string": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyQueryString" - }, - "user": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyUser" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / titleRemoved value: -"Custom Cache Key" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyCookie" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / descriptionRemoved value: -"Which cookies to include in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / propertiesRemoved value: -{ - "check_presence": { - "description": "A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.", - "items": { - "description": "The name of the cookie to check for the presence of.", - "minLength": 1, - "title": "Cookie Name", - "type": "string" - }, - "minItems": 1, - "title": "Check Presence", - "type": "array", - "uniqueItems": true - }, - "include": { - "description": "A list of cookies to include in the cache key.", - "items": { - "description": "The name of the cookie to include.", - "minLength": 1, - "title": "Cookie Name", - "type": "string" - }, - "minItems": 1, - "title": "Include", - "type": "array", - "uniqueItems": true - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / titleRemoved value: -"Cookies" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHeader" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / descriptionRemoved value: -"Which headers to include in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / propertiesRemoved value: -{ - "check_presence": { - "description": "A list of headers to check for the presence of. The presence of these headers is included in the cache key.", - "items": { - "description": "The name of the header to check for the presence of.", - "minLength": 1, - "title": "Header", - "type": "string" - }, - "minItems": 1, - "title": "Check Presence", - "type": "array", - "uniqueItems": true - }, - "contains": { - "additionalProperties": { - "description": "A list of values to match the header against.", - "items": { - "description": "The header value to match against.", - "minLength": 1, - "title": "Header Value", - "type": "string" - }, - "minItems": 1, - "title": "Header Values", - "type": "array", - "uniqueItems": true - }, - "description": "A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.", - "minProperties": 1, - "title": "Contains", - "type": "object" - }, - "exclude_origin": { - "description": "Whether to exclude the origin header in the cache key.", - "title": "Exclude Origin", - "type": "boolean" - }, - "include": { - "description": "A list of headers to include in the cache key.", - "items": { - "description": "The name of the header to include.", - "minLength": 1, - "title": "Header", - "type": "string" - }, - "minItems": 1, - "title": "Include", - "type": "array", - "uniqueItems": true - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / titleRemoved value: -"Headers" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHost" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / descriptionRemoved value: -"How to use the host in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / propertiesRemoved value: -{ - "resolved": { - "description": "Whether to use the resolved host in the cache key.", - "title": "Use Resolved Host", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / titleRemoved value: -"Host" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyQueryString" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / descriptionRemoved value: -"Which query string parameters to include in or exclude from the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / maxPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / propertiesRemoved value: -{ - "exclude": { - "description": "Which query string parameters to exclude from the cache key.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "all": { - "description": "Whether to exclude all query string parameters from the cache key.", - "enum": [ - true - ], - "title": "Exclude All", - "type": "boolean" - }, - "list": { - "description": "A list of query string parameters to exclude from the cache key.", - "items": { - "description": "The name of the query string parameter to exclude.", - "minLength": 1, - "title": "Parameter Name", - "type": "string" - }, - "minItems": 1, - "title": "Exclude List", - "type": "array", - "uniqueItems": true - } - }, - "title": "Exclude", - "type": "object" - }, - "include": { - "description": "Which query string parameters to include in the cache key.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "all": { - "description": "Whether to include all query string parameters in the cache key.", - "enum": [ - true - ], - "title": "Include All", - "type": "boolean" - }, - "list": { - "description": "A list of query string parameters to include in the cache key.", - "items": { - "description": "The name of the query string parameter to include.", - "minLength": 1, - "title": "Parameter Name", - "type": "string" - }, - "minItems": 1, - "title": "Include List", - "type": "array", - "uniqueItems": true - } - }, - "title": "Include", - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / titleRemoved value: -"Query String Parameters" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyUser" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / descriptionRemoved value: -"How to use characteristics of the request user agent in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / propertiesRemoved value: -{ - "device_type": { - "description": "Whether to use the user agent's device type in the cache key.", - "title": "Device Type", - "type": "boolean" - }, - "geo": { - "description": "Whether to use the user agents's country in the cache key.", - "title": "Country", - "type": "boolean" - }, - "lang": { - "description": "Whether to use the user agent's language in the cache key.", - "title": "Language", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / titleRemoved value: -"User" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsEdgeTTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / descriptionRemoved value: -"How long the Cloudflare edge network should cache the response." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / propertiesRemoved value: -{ - "default": { - "description": "The edge TTL (in seconds) if you choose the \"override_origin\" mode.", - "minimum": 0, - "title": "Default TTL", - "type": "integer" - }, - "mode": { - "description": "The edge TTL mode.", - "enum": [ - "respect_origin", - "bypass_by_default", - "override_origin" - ], - "title": "TTL Mode", - "type": "string" - }, - "status_code_ttl": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStatusCodeTTL" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / requiredRemoved value: -[ - "mode" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / titleRemoved value: -"Edge TTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsOriginCacheControl" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / descriptionRemoved value: -"Whether Cloudflare will aim to strictly adhere to RFC 7234." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / titleRemoved value: -"Origin Cache Control (Enterprise-Only)" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsOriginErrorPagePassthru" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / descriptionRemoved value: -"Whether to generate Cloudflare error pages for issues from the origin server." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / titleRemoved value: -"Origin Error Page Passthrough" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsOriginRangeRequests" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / descriptionRemoved value: -"Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / propertiesRemoved value: -{ - "mode": { - "description": "Whether to use range requests. `default` is the behaviour the zone gets without this rule.", - "enum": [ - "on", - "off", - "default" - ], - "title": "Mode", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / requiredRemoved value: -[ - "mode" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / titleRemoved value: -"Origin Range Requests" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsReadTimeout" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / descriptionRemoved value: -"A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / maximumRemoved value: -6000 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / minimumRemoved value: -100 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / titleRemoved value: -"Read Timeout (Enterprise-Only)" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsRespectStrongEtags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / descriptionRemoved value: -"Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / titleRemoved value: -"Respect Strong ETags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRule / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsRule" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_cache_settings" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "additional_cacheable_ports": { - "$ref": "#/$defs/rulesets_SetCacheSettingsAdditionalCacheablePorts" - }, - "browser_ttl": { - "$ref": "#/$defs/rulesets_SetCacheSettingsBrowserTTL" - }, - "cache": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCache" - }, - "cache_key": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCacheKey" - }, - "cache_reserve": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCacheReserve" - }, - "edge_ttl": { - "$ref": "#/$defs/rulesets_SetCacheSettingsEdgeTTL" - }, - "origin_cache_control": { - "$ref": "#/$defs/rulesets_SetCacheSettingsOriginCacheControl" - }, - "origin_error_page_passthru": { - "$ref": "#/$defs/rulesets_SetCacheSettingsOriginErrorPagePassthru" - }, - "origin_range_requests": { - "$ref": "#/$defs/rulesets_SetCacheSettingsOriginRangeRequests" - }, - "read_timeout": { - "$ref": "#/$defs/rulesets_SetCacheSettingsReadTimeout" - }, - "respect_strong_etags": { - "$ref": "#/$defs/rulesets_SetCacheSettingsRespectStrongEtags" - }, - "serve_stale": { - "$ref": "#/$defs/rulesets_SetCacheSettingsServeStale" - }, - "shared_dictionary": { - "$ref": "#/$defs/rulesets_SetCacheSettingsSharedDictionary" - }, - "strip_etags": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStripETags" - }, - "strip_last_modified": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStripLastModified" - }, - "strip_set_cookie": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStripSetCookie" - }, - "vary": { - "$ref": "#/$defs/rulesets_SetCacheSettingsVary" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Set Cache Settings Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsServeStale" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / descriptionRemoved value: -"When to serve stale content from cache." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / propertiesRemoved value: -{ - "disable_stale_while_updating": { - "description": "Whether Cloudflare should disable serving stale content while getting the latest content from the origin.", - "title": "Disable Stale While Updating", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / titleRemoved value: -"Serve Stale" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsSharedDictionary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / descriptionRemoved value: -"Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / propertiesRemoved value: -{ - "match_pattern": { - "description": "URL pattern for the Use-As-Dictionary match field. This pattern specifies which URLs can use this response as a dictionary.", - "maxLength": 1024, - "minLength": 1, - "title": "Match Pattern", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / requiredRemoved value: -[ - "match_pattern" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / titleRemoved value: -"Shared Dictionary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStatusCodeTTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / descriptionRemoved value: -"A list of TTLs to apply to specific status codes or status code ranges." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / itemsRemoved value: -{ - "maxProperties": 2, - "minProperties": 2, - "properties": { - "status_code": { - "description": "A single status code to apply the TTL to.", - "maximum": 999, - "minimum": 100, - "title": "Status Code", - "type": "integer" - }, - "status_code_range": { - "description": "A range of status codes to apply the TTL to.", - "minProperties": 1, - "properties": { - "from": { - "description": "The lower bound of the range.", - "maximum": 999, - "minimum": 100, - "title": "From", - "type": "integer" - }, - "to": { - "description": "The upper bound of the range.", - "maximum": 999, - "minimum": 100, - "title": "To", - "type": "integer" - } - }, - "title": "Status Code Range", - "type": "object" - }, - "value": { - "description": "The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value \"no-cache\". A value of -1 is equivalent to setting the cache control header with the value of \"no-store\".", - "title": "TTL Value", - "type": "integer" - } - }, - "required": [ - "value" - ], - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / titleRemoved value: -"Status Code TTLs" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStripETags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / descriptionRemoved value: -"Whether to strip ETag headers from the origin response before caching." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / titleRemoved value: -"Strip ETags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStripLastModified" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / descriptionRemoved value: -"Whether to strip Last-Modified headers from the origin response before caching." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / titleRemoved value: -"Strip Last-Modified" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStripSetCookie" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / descriptionRemoved value: -"Whether to strip Set-Cookie headers from the origin response before caching." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / titleRemoved value: -"Strip Set-Cookie" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsVary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / descriptionRemoved value: -"Controls how cached responses vary based on request headers. `default` is required by the API and applies to any Vary response header that does not have a per-header override." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / propertiesRemoved value: -{ - "default": { - "$ref": "#/$defs/rulesets_SetCacheSettingsVaryDefault" - }, - "headers": { - "additionalProperties": { - "$ref": "#/$defs/rulesets_SetCacheSettingsVaryHeader" - }, - "description": "A mapping of lowercase request header names to their vary configuration.", - "maxProperties": 50, - "title": "Headers", - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / titleRemoved value: -"Vary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsVaryDefault" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / descriptionRemoved value: -"Controls how response Vary headers without a per-header override contribute to the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / propertiesRemoved value: -{ - "action": { - "description": "How the header value is treated when building the cache key.", - "enum": [ - "bypass", - "passthrough", - "normalize" - ], - "title": "Action", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / requiredRemoved value: -[ - "action" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / titleRemoved value: -"Vary Default" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsVaryHeader" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / descriptionRemoved value: -"Controls how a single request header contributes to the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / propertiesRemoved value: -{ - "action": { - "description": "How the header value is treated when building the cache key.", - "enum": [ - "bypass", - "passthrough", - "normalize" - ], - "title": "Action", - "type": "string" - }, - "languages": { - "description": "The set of languages to normalize against. Only valid for the `accept-language` header.", - "items": { - "description": "A language tag to normalize against. Must be printable ASCII.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[ -~]+$", - "title": "Language", - "type": "string" - }, - "maxItems": 20, - "title": "Languages", - "type": "array" - }, - "media_types": { - "description": "The set of media types to normalize against. Only valid for the `accept` header.", - "items": { - "description": "A media type to normalize against. Must be printable ASCII.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[ -~]+$", - "title": "Media Type", - "type": "string" - }, - "maxItems": 10, - "title": "Media Types", - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / requiredRemoved value: -[ - "action" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / titleRemoved value: -"Vary Header" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / $refAdded value: +"#/$defs/rulesets_SetCacheTagsExpression" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / descriptionRemoved value: -"An expression that evaluates to an array of cache tag values." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / titleRemoved value: -"Expression" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / $refAdded value: +"#/$defs/rulesets_SetCacheTagsOperation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / descriptionRemoved value: -"The operation to perform on the cache tags." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / enumRemoved value: -[ - "add", - "remove", - "set" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / titleRemoved value: -"Operation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsRule / $refAdded value: +"#/$defs/rulesets_SetCacheTagsRule" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_cache_tags" - ], - "type": "string" - }, - "action_parameters": { - "oneOf": [ - { - "description": "Add cache tags using a list of values.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - }, - "values": { - "$ref": "#/$defs/rulesets_SetCacheTagsValues" - } - }, - "required": [ - "operation", - "values" - ], - "title": "Add Cache Tags (Values)", - "type": "object" - }, - { - "description": "Add cache tags using an expression.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_SetCacheTagsExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Add Cache Tags (Expression)", - "type": "object" - }, - { - "description": "Remove cache tags using a list of values.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - }, - "values": { - "$ref": "#/$defs/rulesets_SetCacheTagsValues" - } - }, - "required": [ - "operation", - "values" - ], - "title": "Remove Cache Tags (Values)", - "type": "object" - }, - { - "description": "Remove cache tags using an expression.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_SetCacheTagsExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Remove Cache Tags (Expression)", - "type": "object" - }, - { - "description": "Set cache tags using a list of values.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "values": { - "$ref": "#/$defs/rulesets_SetCacheTagsValues" - } - }, - "required": [ - "operation", - "values" - ], - "title": "Set Cache Tags (Values)", - "type": "object" - }, - { - "description": "Set cache tags using an expression.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_SetCacheTagsExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Set Cache Tags (Expression)", - "type": "object" - } - ] - }, - "description": { - "type": "string" - } - }, - "title": "Set Cache Tags Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / $refAdded value: +"#/$defs/rulesets_SetCacheTagsValues" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / descriptionRemoved value: -"A list of cache tag values." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / itemsRemoved value: -{ - "description": "A cache tag value.", - "minLength": 1, - "title": "Cache Tag", - "type": "string" -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / maxItemsRemoved value: -100 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / titleRemoved value: -"Values" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / $refAdded value: +"#/$defs/rulesets_SetConfigAutominify" - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / descriptionRemoved value: -"Which file extensions to minify automatically." - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / propertiesRemoved value: -{ - "css": { - "default": false, - "description": "Whether to minify CSS files.", - "title": "CSS", - "type": "boolean" - }, - "html": { - "default": false, - "description": "Whether to minify HTML files.", - "title": "HTML", - "type": "boolean" - }, - "js": { - "default": false, - "description": "Whether to minify JavaScript files.", - "title": "JavaScript", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / titleRemoved value: -"Auto-Minify" - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetConfigRule / $refAdded value: +"#/$defs/rulesets_SetConfigRule" - removed
Input schema / properties / payload / $defs / rulesets_SetConfigRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_config" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "automatic_https_rewrites": { - "description": "Whether to enable Automatic HTTPS Rewrites.", - "title": "Automatic HTTPS Rewrites", - "type": "boolean" - }, - "autominify": { - "$ref": "#/$defs/rulesets_SetConfigAutominify" - }, - "bic": { - "description": "Whether to enable Browser Integrity Check (BIC).", - "title": "Browser Integrity Check", - "type": "boolean" - }, - "content_converter": { - "description": "Whether to enable content conversion (e.g., HTML to Markdown).", - "title": "Content Converter", - "type": "boolean" - }, - "disable_apps": { - "deprecated": true, - "description": "Whether to disable Cloudflare Apps.", - "enum": [ - true - ], - "title": "Disable Apps", - "type": "boolean" - }, - "disable_pay_per_crawl": { - "description": "Whether to disable Pay Per Crawl.", - "enum": [ - true - ], - "title": "Disable Pay Per Crawl", - "type": "boolean" - }, - "disable_rum": { - "description": "Whether to disable Real User Monitoring (RUM).", - "enum": [ - true - ], - "title": "Disable RUM", - "type": "boolean" - }, - "disable_zaraz": { - "description": "Whether to disable Zaraz.", - "enum": [ - true - ], - "title": "Disable Zaraz", - "type": "boolean" - }, - "email_obfuscation": { - "description": "Whether to enable Email Obfuscation.", - "title": "Email Obfuscation", - "type": "boolean" - }, - "fonts": { - "description": "Whether to enable Cloudflare Fonts.", - "title": "Cloudflare Fonts", - "type": "boolean" - }, - "hotlink_protection": { - "description": "Whether to enable Hotlink Protection.", - "title": "Hotlink Protection", - "type": "boolean" - }, - "mirage": { - "deprecated": true, - "description": "Whether to enable Mirage.", - "title": "Mirage", - "type": "boolean" - }, - "opportunistic_encryption": { - "description": "Whether to enable Opportunistic Encryption.", - "title": "Opportunistic Encryption", - "type": "boolean" - }, - "polish": { - "description": "The Polish level to configure.", - "enum": [ - "off", - "lossless", - "lossy", - "webp" - ], - "title": "Polish", - "type": "string" - }, - "redirects_for_ai_training": { - "description": "Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response.", - "title": "Redirects for AI Training", - "type": "boolean" - }, - "request_body_buffering": { - "description": "The request body buffering mode.", - "enum": [ - "none", - "standard", - "full" - ], - "title": "Request body buffering", - "type": "string" - }, - "response_body_buffering": { - "description": "The response body buffering mode.", - "enum": [ - "none", - "standard" - ], - "title": "Response body buffering", - "type": "string" - }, - "rocket_loader": { - "description": "Whether to enable Rocket Loader.", - "title": "Rocket Loader", - "type": "boolean" - }, - "security_level": { - "description": "The Security Level to configure.", - "enum": [ - "off", - "essentially_off", - "low", - "medium", - "high", - "under_attack" - ], - "title": "Security Level", - "type": "string" - }, - "server_side_excludes": { - "description": "Whether to enable Server-Side Excludes.", - "title": "Server-Side Excludes", - "type": "boolean" - }, - "ssl": { - "description": "The SSL level to configure.", - "enum": [ - "off", - "flexible", - "full", - "strict", - "origin_pull" - ], - "title": "SSL", - "type": "string" - }, - "sxg": { - "deprecated": true, - "description": "Whether to enable Signed Exchanges (SXG).", - "title": "Signed Exchanges", - "type": "boolean" - }, - "webmcp_enabled": { - "description": "Whether to serve the WebMCP bridge script, which exposes the page's tools to browser AI agents.", - "title": "WebMCP", - "type": "boolean" - }, - "webmcp_packs": { - "description": "Bundled WebMCP tool packs to activate for matching requests. An empty array disables all packs. Omitting this parameter leaves the pack selection unchanged. Does not enable the WebMCP bridge itself. Non-empty selections require the WebMCP Configuration Rules entitlement.", - "items": { - "description": "A tool-pack identifier understood by the WebMCP interceptor.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Za-z0-9._:/@-]+$", - "type": "string" - }, - "maxItems": 100, - "title": "WebMCP Tool Packs", - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Set Configuration Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SkipPhase / $refAdded value: +"#/$defs/rulesets_SkipPhase" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / descriptionRemoved value: -"A phase to skip the execution of. This option is only compatible with the products option." - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / enumRemoved value: -[ - "current" -] - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / titleRemoved value: -"Phase" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SkipPhases / $refAdded value: +"#/$defs/rulesets_SkipPhases" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / descriptionRemoved value: -"A list of phases to skip the execution of. This option is incompatible with the rulesets option." - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / itemsRemoved value: -{ - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetPhase" - }, - { - "description": "The phase to skip the execution of.", - "type": "string" - } - ] -} - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / titleRemoved value: -"Phases" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SkipProducts / $refAdded value: +"#/$defs/rulesets_SkipProducts" - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / descriptionRemoved value: -"A list of legacy security products to skip the execution of." - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / itemsRemoved value: -{ - "description": "The name of a legacy security product to skip the execution of.", - "enum": [ - "bic", - "hot", - "rateLimit", - "securityLevel", - "uaBlock", - "waf", - "zoneLockdown" - ], - "title": "Product", - "type": "string" -} - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / titleRemoved value: -"Products" - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SkipRule / $refAdded value: +"#/$defs/rulesets_SkipRule" - removed
Input schema / properties / payload / $defs / rulesets_SkipRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "skip" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "phase": { - "$ref": "#/$defs/rulesets_SkipPhase" - }, - "phases": { - "$ref": "#/$defs/rulesets_SkipPhases" - }, - "products": { - "$ref": "#/$defs/rulesets_SkipProducts" - }, - "rules": { - "$ref": "#/$defs/rulesets_SkipRules" - }, - "ruleset": { - "$ref": "#/$defs/rulesets_SkipRuleset" - }, - "rulesets": { - "$ref": "#/$defs/rulesets_SkipRulesets" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Skip Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SkipRules / $refAdded value: +"#/$defs/rulesets_SkipRules" - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / additionalPropertiesRemoved value: -{ - "description": "A list of rule IDs in the ruleset to skip the execution of.", - "items": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleId" - }, - { - "description": "The ID of a rule in the ruleset to skip the execution of.", - "title": "Rule", - "type": "string" - } - ] - }, - "minItems": 1, - "title": "Rules", - "type": "array", - "uniqueItems": true -} - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / descriptionRemoved value: -"A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option." - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / titleRemoved value: -"Rules" - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SkipRuleset / $refAdded value: +"#/$defs/rulesets_SkipRuleset" - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / descriptionRemoved value: -"A ruleset to skip the execution of. This option is incompatible with the rulesets option." - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / enumRemoved value: -[ - "current" -] - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / titleRemoved value: -"Ruleset" - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SkipRulesets / $refAdded value: +"#/$defs/rulesets_SkipRulesets" - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / descriptionRemoved value: -"A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options." - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / itemsRemoved value: -{ - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetId" - }, - { - "description": "The ID of a ruleset to skip the execution of.", - "title": "Ruleset", - "type": "string" - } - ] -} - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / titleRemoved value: -"Rulesets" - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_TransformResponseHTMLRule / $refAdded value: +"#/$defs/rulesets_TransformResponseHTMLRule" - removed
Input schema / properties / payload / $defs / rulesets_TransformResponseHTMLRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "transform_response_html" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "link_maze": { - "description": "Enables the link maze transformation on the response.", - "title": "Link Maze", - "type": "object" - } - }, - "required": [ - "link_maze" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Transform Response HTML Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ZoneId / $refAdded value: +"#/$defs/rulesets_ZoneId" - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / descriptionRemoved value: -"The unique ID of the zone." - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / patternRemoved value: -"^[0-9a-f]{32}$" - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / titleRemoved value: -"Zone ID" - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / typeRemoved value: -"string"
- Changed
delete_dns_record1 field changed- changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action."
- Changed
delete_zone_ruleset1 field changed- changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action."
- Changed
overwrite_dns_record129 fields changed- changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / dns-records_AAAARecord / $refAdded value: +"#/$defs/dns-records_AAAARecord" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv6 address.", - "format": "ipv6", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "AAAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / titleRemoved value: -"AAAA Record" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_ARecord / $refAdded value: +"#/$defs/dns-records_ARecord" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv4 address.", - "format": "ipv4", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "A" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ARecord / titleRemoved value: -"A Record" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CAARecord / $refAdded value: +"#/$defs/dns-records_CAARecord" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CAA content. See 'data' to set CAA properties.", - "type": "string" - }, - "data": { - "description": "Components of a CAA record.", - "properties": { - "flags": { - "description": "Flags for the CAA record.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "tag": { - "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", - "type": "string" - }, - "value": { - "description": "Value of the record. This field's semantics depend on the chosen tag.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / titleRemoved value: -"CAA Record" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CERTRecord / $refAdded value: +"#/$defs/dns-records_CERTRecord" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CERT content. See 'data' to set CERT properties.", - "type": "string" - }, - "data": { - "description": "Components of a CERT record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "type": { - "description": "Type.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CERT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / titleRemoved value: -"CERT Record" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CNAMERecord / $refAdded value: +"#/$defs/dns-records_CNAMERecord" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid hostname. Must not match the record's name.", - "type": "string" - }, - "settings": { - "properties": { - "flatten_cname": { - "default": false, - "description": "If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CNAME" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / titleRemoved value: -"CNAME Record" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / $refAdded value: +"#/$defs/dns-records_DNSKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", - "type": "string" - }, - "data": { - "description": "Components of a DNSKEY record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "flags": { - "description": "Flags.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "protocol": { - "description": "Protocol.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "public_key": { - "description": "Public Key.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DNSKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / titleRemoved value: -"DNSKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DSRecord / $refAdded value: +"#/$defs/dns-records_DSRecord" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DS content. See 'data' to set DS properties.", - "type": "string" - }, - "data": { - "description": "Components of a DS record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "digest": { - "description": "Digest.", - "type": "string" - }, - "digest_type": { - "description": "Digest Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / titleRemoved value: -"DS Record" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / $refAdded value: +"#/$defs/dns-records_HTTPSRecord" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", - "type": "string" - }, - "data": { - "description": "Components of a HTTPS record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "HTTPS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / titleRemoved value: -"HTTPS Record" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_LOCRecord / $refAdded value: +"#/$defs/dns-records_LOCRecord" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted LOC content. See 'data' to set LOC properties.", - "type": "string" - }, - "data": { - "description": "Components of a LOC record.", - "properties": { - "altitude": { - "description": "Altitude of location in meters.", - "maximum": 42849672.95, - "minimum": -100000, - "type": "number" - }, - "lat_degrees": { - "description": "Degrees of latitude.", - "maximum": 90, - "minimum": 0, - "type": "number" - }, - "lat_direction": { - "description": "Latitude direction.", - "enum": [ - "N", - "S" - ], - "type": "string" - }, - "lat_minutes": { - "description": "Minutes of latitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "lat_seconds": { - "description": "Seconds of latitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "long_degrees": { - "description": "Degrees of longitude.", - "maximum": 180, - "minimum": 0, - "type": "number" - }, - "long_direction": { - "description": "Longitude direction.", - "enum": [ - "E", - "W" - ], - "type": "string" - }, - "long_minutes": { - "description": "Minutes of longitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "long_seconds": { - "description": "Seconds of longitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "precision_horz": { - "description": "Horizontal precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "precision_vert": { - "description": "Vertical precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "size": { - "description": "Size of location in meters.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "LOC" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / titleRemoved value: -"LOC Record" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_MXRecord / $refAdded value: +"#/$defs/dns-records_MXRecord" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid mail server hostname.", - "format": "hostname", - "type": "string" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "MX" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / titleRemoved value: -"MX Record" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / $refAdded value: +"#/$defs/dns-records_NAPTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", - "type": "string" - }, - "data": { - "description": "Components of a NAPTR record.", - "properties": { - "flags": { - "description": "Flags.", - "type": "string" - }, - "order": { - "description": "Order.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "preference": { - "description": "Preference.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "regex": { - "description": "Regex.", - "type": "string" - }, - "replacement": { - "description": "Replacement.", - "type": "string" - }, - "service": { - "description": "Service.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "NAPTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / titleRemoved value: -"NAPTR Record" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NSRecord / $refAdded value: +"#/$defs/dns-records_NSRecord" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid name server host name.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "NS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / titleRemoved value: -"NS Record" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / $refAdded value: +"#/$defs/dns-records_OPENPGPKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "OPENPGPKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / titleRemoved value: -"OPENPGPKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_PTRRecord / $refAdded value: +"#/$defs/dns-records_PTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Domain name pointing to the address.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "PTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / titleRemoved value: -"PTR Record" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / $refAdded value: +"#/$defs/dns-records_SMIMEARecord" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", - "type": "string" - }, - "data": { - "description": "Components of a SMIMEA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SMIMEA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / titleRemoved value: -"SMIMEA Record" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SRVRecord / $refAdded value: +"#/$defs/dns-records_SRVRecord" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", - "type": "string" - }, - "data": { - "description": "Components of a SRV record.", - "properties": { - "port": { - "description": "The port of the service.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "target": { - "description": "A valid hostname.", - "format": "hostname", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SRV" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / titleRemoved value: -"SRV Record" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / $refAdded value: +"#/$defs/dns-records_SSHFPRecord" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", - "type": "string" - }, - "data": { - "description": "Components of a SSHFP record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "fingerprint": { - "description": "Fingerprint.", - "type": "string" - }, - "type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SSHFP" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / titleRemoved value: -"SSHFP Record" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SVCBRecord / $refAdded value: +"#/$defs/dns-records_SVCBRecord" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SVCB content. See 'data' to set SVCB properties.", - "type": "string" - }, - "data": { - "description": "Components of a SVCB record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SVCB" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / titleRemoved value: -"SVCB Record" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TLSARecord / $refAdded value: +"#/$defs/dns-records_TLSARecord" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted TLSA content. See 'data' to set TLSA properties.", - "type": "string" - }, - "data": { - "description": "Components of a TLSA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "TLSA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / titleRemoved value: -"TLSA Record" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TXTRecord / $refAdded value: +"#/$defs/dns-records_TXTRecord" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at <https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/>.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "TXT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / titleRemoved value: -"TXT Record" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_URIRecord / $refAdded value: +"#/$defs/dns-records_URIRecord" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted URI content. See 'data' to set URI properties.", - "type": "string" - }, - "data": { - "description": "Components of a URI record.", - "properties": { - "target": { - "description": "The record content.", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "URI" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / titleRemoved value: -"URI Record" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_comment / $refAdded value: +"#/$defs/dns-records_comment" - removed
Input schema / properties / payload / $defs / dns-records_comment / descriptionRemoved value: -"Comments or notes about the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_comment / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / $refAdded value: +"#/$defs/dns-records_dns-record-shared-fields" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / propertiesRemoved value: -{ - "comment": { - "$ref": "#/$defs/dns-records_comment" - }, - "name": { - "$ref": "#/$defs/dns-records_name" - }, - "proxied": { - "$ref": "#/$defs/dns-records_proxied" - }, - "settings": { - "$ref": "#/$defs/dns-records_settings" - }, - "tags": { - "$ref": "#/$defs/dns-records_tags" - }, - "ttl": { - "$ref": "#/$defs/dns-records_ttl" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / $refAdded value: +"#/$defs/dns-records_dns-record-with-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_CAARecord" - }, - { - "$ref": "#/$defs/dns-records_CERTRecord" - }, - { - "$ref": "#/$defs/dns-records_DNSKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_DSRecord" - }, - { - "$ref": "#/$defs/dns-records_HTTPSRecord" - }, - { - "$ref": "#/$defs/dns-records_LOCRecord" - }, - { - "$ref": "#/$defs/dns-records_NAPTRRecord" - }, - { - "$ref": "#/$defs/dns-records_SMIMEARecord" - }, - { - "$ref": "#/$defs/dns-records_SRVRecord" - }, - { - "$ref": "#/$defs/dns-records_SSHFPRecord" - }, - { - "$ref": "#/$defs/dns-records_SVCBRecord" - }, - { - "$ref": "#/$defs/dns-records_TLSARecord" - }, - { - "$ref": "#/$defs/dns-records_URIRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / $refAdded value: +"#/$defs/dns-records_dns-record-without-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_ARecord" - }, - { - "$ref": "#/$defs/dns-records_AAAARecord" - }, - { - "$ref": "#/$defs/dns-records_CNAMERecord" - }, - { - "$ref": "#/$defs/dns-records_MXRecord" - }, - { - "$ref": "#/$defs/dns-records_NSRecord" - }, - { - "$ref": "#/$defs/dns-records_OPENPGPKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_PTRRecord" - }, - { - "$ref": "#/$defs/dns-records_TXTRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_identifier / $refAdded value: +"#/$defs/dns-records_identifier" - removed
Input schema / properties / payload / $defs / dns-records_identifier / descriptionRemoved value: -"Identifier." - removed
Input schema / properties / payload / $defs / dns-records_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / dns-records_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_name / $refAdded value: +"#/$defs/dns-records_name" - removed
Input schema / properties / payload / $defs / dns-records_name / descriptionRemoved value: -"Complete DNS record name, including the zone name, in Punycode." - removed
Input schema / properties / payload / $defs / dns-records_name / maxLengthRemoved value: -255 - removed
Input schema / properties / payload / $defs / dns-records_name / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_priority / $refAdded value: +"#/$defs/dns-records_priority" - removed
Input schema / properties / payload / $defs / dns-records_priority / descriptionRemoved value: -"Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map." - removed
Input schema / properties / payload / $defs / dns-records_priority / maximumRemoved value: -65535 - removed
Input schema / properties / payload / $defs / dns-records_priority / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / dns-records_priority / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / dns-records_proxied / $refAdded value: +"#/$defs/dns-records_proxied" - removed
Input schema / properties / payload / $defs / dns-records_proxied / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / dns-records_proxied / descriptionRemoved value: -"Whether the record is receiving the performance and security benefits of Cloudflare." - removed
Input schema / properties / payload / $defs / dns-records_proxied / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / dns-records_settings / $refAdded value: +"#/$defs/dns-records_settings" - removed
Input schema / properties / payload / $defs / dns-records_settings / descriptionRemoved value: -"Settings for the DNS record." - removed
Input schema / properties / payload / $defs / dns-records_settings / propertiesRemoved value: -{ - "ipv4_only": { - "default": false, - "description": "When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - }, - "ipv6_only": { - "default": false, - "description": "When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / dns-records_settings / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_tags / $refAdded value: +"#/$defs/dns-records_tags" - removed
Input schema / properties / payload / $defs / dns-records_tags / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / dns-records_tags / descriptionRemoved value: -"Custom tags for the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_tags / itemsRemoved value: -{ - "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", - "type": "string" -} - removed
Input schema / properties / payload / $defs / dns-records_tags / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / dns-records_ttl / $refAdded value: +"#/$defs/dns-records_ttl" - removed
Input schema / properties / payload / $defs / dns-records_ttl / anyOfRemoved value: -[ - { - "maximum": 86400, - "minimum": 30, - "type": "number" - }, - { - "enum": [ - 1 - ], - "type": "number" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ttl / defaultRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_ttl / descriptionRemoved value: -"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones." - removed
Input schema / properties / payload / $defs / dns-records_ttl / typeRemoved value: -"number"
- Changed
preview_dns_batch154 fields changed- added
Input schema / $defs / dns-records_dns-record-post / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / $defs / dns-records_dns-record-post / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / $defs / dns-records_dns-record-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_AAAARecord / $refAdded value: +"#/$defs/dns-records_AAAARecord" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv6 address.", - "format": "ipv6", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "AAAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / titleRemoved value: -"AAAA Record" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_ARecord / $refAdded value: +"#/$defs/dns-records_ARecord" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv4 address.", - "format": "ipv4", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "A" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ARecord / titleRemoved value: -"A Record" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CAARecord / $refAdded value: +"#/$defs/dns-records_CAARecord" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CAA content. See 'data' to set CAA properties.", - "type": "string" - }, - "data": { - "description": "Components of a CAA record.", - "properties": { - "flags": { - "description": "Flags for the CAA record.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "tag": { - "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", - "type": "string" - }, - "value": { - "description": "Value of the record. This field's semantics depend on the chosen tag.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / titleRemoved value: -"CAA Record" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CERTRecord / $refAdded value: +"#/$defs/dns-records_CERTRecord" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CERT content. See 'data' to set CERT properties.", - "type": "string" - }, - "data": { - "description": "Components of a CERT record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "type": { - "description": "Type.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CERT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / titleRemoved value: -"CERT Record" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CNAMERecord / $refAdded value: +"#/$defs/dns-records_CNAMERecord" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid hostname. Must not match the record's name.", - "type": "string" - }, - "settings": { - "properties": { - "flatten_cname": { - "default": false, - "description": "If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CNAME" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / titleRemoved value: -"CNAME Record" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / $refAdded value: +"#/$defs/dns-records_DNSKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", - "type": "string" - }, - "data": { - "description": "Components of a DNSKEY record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "flags": { - "description": "Flags.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "protocol": { - "description": "Protocol.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "public_key": { - "description": "Public Key.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DNSKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / titleRemoved value: -"DNSKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DSRecord / $refAdded value: +"#/$defs/dns-records_DSRecord" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DS content. See 'data' to set DS properties.", - "type": "string" - }, - "data": { - "description": "Components of a DS record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "digest": { - "description": "Digest.", - "type": "string" - }, - "digest_type": { - "description": "Digest Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / titleRemoved value: -"DS Record" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / $refAdded value: +"#/$defs/dns-records_HTTPSRecord" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", - "type": "string" - }, - "data": { - "description": "Components of a HTTPS record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "HTTPS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / titleRemoved value: -"HTTPS Record" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_LOCRecord / $refAdded value: +"#/$defs/dns-records_LOCRecord" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted LOC content. See 'data' to set LOC properties.", - "type": "string" - }, - "data": { - "description": "Components of a LOC record.", - "properties": { - "altitude": { - "description": "Altitude of location in meters.", - "maximum": 42849672.95, - "minimum": -100000, - "type": "number" - }, - "lat_degrees": { - "description": "Degrees of latitude.", - "maximum": 90, - "minimum": 0, - "type": "number" - }, - "lat_direction": { - "description": "Latitude direction.", - "enum": [ - "N", - "S" - ], - "type": "string" - }, - "lat_minutes": { - "description": "Minutes of latitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "lat_seconds": { - "description": "Seconds of latitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "long_degrees": { - "description": "Degrees of longitude.", - "maximum": 180, - "minimum": 0, - "type": "number" - }, - "long_direction": { - "description": "Longitude direction.", - "enum": [ - "E", - "W" - ], - "type": "string" - }, - "long_minutes": { - "description": "Minutes of longitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "long_seconds": { - "description": "Seconds of longitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "precision_horz": { - "description": "Horizontal precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "precision_vert": { - "description": "Vertical precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "size": { - "description": "Size of location in meters.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "LOC" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / titleRemoved value: -"LOC Record" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_MXRecord / $refAdded value: +"#/$defs/dns-records_MXRecord" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid mail server hostname.", - "format": "hostname", - "type": "string" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "MX" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / titleRemoved value: -"MX Record" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / $refAdded value: +"#/$defs/dns-records_NAPTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", - "type": "string" - }, - "data": { - "description": "Components of a NAPTR record.", - "properties": { - "flags": { - "description": "Flags.", - "type": "string" - }, - "order": { - "description": "Order.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "preference": { - "description": "Preference.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "regex": { - "description": "Regex.", - "type": "string" - }, - "replacement": { - "description": "Replacement.", - "type": "string" - }, - "service": { - "description": "Service.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "NAPTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / titleRemoved value: -"NAPTR Record" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NSRecord / $refAdded value: +"#/$defs/dns-records_NSRecord" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid name server host name.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "NS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / titleRemoved value: -"NS Record" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / $refAdded value: +"#/$defs/dns-records_OPENPGPKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "OPENPGPKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / titleRemoved value: -"OPENPGPKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_PTRRecord / $refAdded value: +"#/$defs/dns-records_PTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Domain name pointing to the address.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "PTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / titleRemoved value: -"PTR Record" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / $refAdded value: +"#/$defs/dns-records_SMIMEARecord" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", - "type": "string" - }, - "data": { - "description": "Components of a SMIMEA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SMIMEA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / titleRemoved value: -"SMIMEA Record" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SRVRecord / $refAdded value: +"#/$defs/dns-records_SRVRecord" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", - "type": "string" - }, - "data": { - "description": "Components of a SRV record.", - "properties": { - "port": { - "description": "The port of the service.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "target": { - "description": "A valid hostname.", - "format": "hostname", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SRV" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / titleRemoved value: -"SRV Record" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / $refAdded value: +"#/$defs/dns-records_SSHFPRecord" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", - "type": "string" - }, - "data": { - "description": "Components of a SSHFP record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "fingerprint": { - "description": "Fingerprint.", - "type": "string" - }, - "type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SSHFP" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / titleRemoved value: -"SSHFP Record" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SVCBRecord / $refAdded value: +"#/$defs/dns-records_SVCBRecord" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SVCB content. See 'data' to set SVCB properties.", - "type": "string" - }, - "data": { - "description": "Components of a SVCB record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SVCB" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / titleRemoved value: -"SVCB Record" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TLSARecord / $refAdded value: +"#/$defs/dns-records_TLSARecord" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted TLSA content. See 'data' to set TLSA properties.", - "type": "string" - }, - "data": { - "description": "Components of a TLSA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "TLSA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / titleRemoved value: -"TLSA Record" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TXTRecord / $refAdded value: +"#/$defs/dns-records_TXTRecord" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at <https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/>.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "TXT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / titleRemoved value: -"TXT Record" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_URIRecord / $refAdded value: +"#/$defs/dns-records_URIRecord" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted URI content. See 'data' to set URI properties.", - "type": "string" - }, - "data": { - "description": "Components of a URI record.", - "properties": { - "target": { - "description": "The record content.", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "URI" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / titleRemoved value: -"URI Record" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_comment / $refAdded value: +"#/$defs/dns-records_comment" - removed
Input schema / properties / payload / $defs / dns-records_comment / descriptionRemoved value: -"Comments or notes about the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_comment / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / $refAdded value: +"#/$defs/dns-records_dns-record-batch-delete" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / allOfRemoved value: -[ - { - "properties": { - "id": { - "$ref": "#/$defs/dns-records_identifier" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-delete / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / $refAdded value: +"#/$defs/dns-records_dns-record-batch-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-patch" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / propertiesRemoved value: -{ - "id": { - "$ref": "#/$defs/dns-records_identifier" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-patch / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / $refAdded value: +"#/$defs/dns-records_dns-record-batch-post" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-post" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / $refAdded value: +"#/$defs/dns-records_dns-record-batch-put" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-post" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / propertiesRemoved value: -{ - "id": { - "$ref": "#/$defs/dns-records_identifier" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / requiredRemoved value: -[ - "id" -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-batch-put / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-patch / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-patch / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-patch / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-post / $refAdded value: +"#/$defs/dns-records_dns-record-patch" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-post / anyOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-without-data" - }, - { - "$ref": "#/$defs/dns-records_dns-record-with-data" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-post / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / $refAdded value: +"#/$defs/dns-records_dns-record-shared-fields" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / propertiesRemoved value: -{ - "comment": { - "$ref": "#/$defs/dns-records_comment" - }, - "name": { - "$ref": "#/$defs/dns-records_name" - }, - "proxied": { - "$ref": "#/$defs/dns-records_proxied" - }, - "settings": { - "$ref": "#/$defs/dns-records_settings" - }, - "tags": { - "$ref": "#/$defs/dns-records_tags" - }, - "ttl": { - "$ref": "#/$defs/dns-records_ttl" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / $refAdded value: +"#/$defs/dns-records_dns-record-with-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_CAARecord" - }, - { - "$ref": "#/$defs/dns-records_CERTRecord" - }, - { - "$ref": "#/$defs/dns-records_DNSKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_DSRecord" - }, - { - "$ref": "#/$defs/dns-records_HTTPSRecord" - }, - { - "$ref": "#/$defs/dns-records_LOCRecord" - }, - { - "$ref": "#/$defs/dns-records_NAPTRRecord" - }, - { - "$ref": "#/$defs/dns-records_SMIMEARecord" - }, - { - "$ref": "#/$defs/dns-records_SRVRecord" - }, - { - "$ref": "#/$defs/dns-records_SSHFPRecord" - }, - { - "$ref": "#/$defs/dns-records_SVCBRecord" - }, - { - "$ref": "#/$defs/dns-records_TLSARecord" - }, - { - "$ref": "#/$defs/dns-records_URIRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / $refAdded value: +"#/$defs/dns-records_dns-record-without-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_ARecord" - }, - { - "$ref": "#/$defs/dns-records_AAAARecord" - }, - { - "$ref": "#/$defs/dns-records_CNAMERecord" - }, - { - "$ref": "#/$defs/dns-records_MXRecord" - }, - { - "$ref": "#/$defs/dns-records_NSRecord" - }, - { - "$ref": "#/$defs/dns-records_OPENPGPKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_PTRRecord" - }, - { - "$ref": "#/$defs/dns-records_TXTRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_identifier / $refAdded value: +"#/$defs/dns-records_identifier" - removed
Input schema / properties / payload / $defs / dns-records_identifier / descriptionRemoved value: -"Identifier." - removed
Input schema / properties / payload / $defs / dns-records_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / dns-records_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_name / $refAdded value: +"#/$defs/dns-records_name" - removed
Input schema / properties / payload / $defs / dns-records_name / descriptionRemoved value: -"Complete DNS record name, including the zone name, in Punycode." - removed
Input schema / properties / payload / $defs / dns-records_name / maxLengthRemoved value: -255 - removed
Input schema / properties / payload / $defs / dns-records_name / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_priority / $refAdded value: +"#/$defs/dns-records_priority" - removed
Input schema / properties / payload / $defs / dns-records_priority / descriptionRemoved value: -"Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map." - removed
Input schema / properties / payload / $defs / dns-records_priority / maximumRemoved value: -65535 - removed
Input schema / properties / payload / $defs / dns-records_priority / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / dns-records_priority / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / dns-records_proxied / $refAdded value: +"#/$defs/dns-records_proxied" - removed
Input schema / properties / payload / $defs / dns-records_proxied / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / dns-records_proxied / descriptionRemoved value: -"Whether the record is receiving the performance and security benefits of Cloudflare." - removed
Input schema / properties / payload / $defs / dns-records_proxied / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / dns-records_settings / $refAdded value: +"#/$defs/dns-records_settings" - removed
Input schema / properties / payload / $defs / dns-records_settings / descriptionRemoved value: -"Settings for the DNS record." - removed
Input schema / properties / payload / $defs / dns-records_settings / propertiesRemoved value: -{ - "ipv4_only": { - "default": false, - "description": "When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - }, - "ipv6_only": { - "default": false, - "description": "When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / dns-records_settings / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_tags / $refAdded value: +"#/$defs/dns-records_tags" - removed
Input schema / properties / payload / $defs / dns-records_tags / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / dns-records_tags / descriptionRemoved value: -"Custom tags for the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_tags / itemsRemoved value: -{ - "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", - "type": "string" -} - removed
Input schema / properties / payload / $defs / dns-records_tags / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / dns-records_ttl / $refAdded value: +"#/$defs/dns-records_ttl" - removed
Input schema / properties / payload / $defs / dns-records_ttl / anyOfRemoved value: -[ - { - "maximum": 86400, - "minimum": 30, - "type": "number" - }, - { - "enum": [ - 1 - ], - "type": "number" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ttl / defaultRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_ttl / descriptionRemoved value: -"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones." - removed
Input schema / properties / payload / $defs / dns-records_ttl / typeRemoved value: -"number"
- Changed
purge_cache28 fields changed- changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / cache-purge_Everything / $refAdded value: +"#/$defs/cache-purge_Everything" - removed
Input schema / properties / payload / $defs / cache-purge_Everything / propertiesRemoved value: -{ - "purge_everything": { - "description": "Set to `true` to target all cached content in the zone, or in the environment for the environment endpoints. Must be the only field in the request. See [Purge everything](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / cache-purge_Everything / titleRemoved value: -"Purge everything" - removed
Input schema / properties / payload / $defs / cache-purge_Everything / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByHostnames / $refAdded value: +"#/$defs/cache-purge_FlexPurgeByHostnames" - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByHostnames / propertiesRemoved value: -{ - "hosts": { - "description": "Hostnames, such as `www.example.com`. Targets all content cached for these hostnames. See [Purge cache by hostname](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByHostnames / titleRemoved value: -"Purge by hostnames" - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByHostnames / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByPrefixes / $refAdded value: +"#/$defs/cache-purge_FlexPurgeByPrefixes" - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByPrefixes / propertiesRemoved value: -{ - "prefixes": { - "description": "URL prefixes, each a hostname followed by a path, such as `www.example.com/blog/`. Targets all content whose URL starts with one of these prefixes. Do not include a scheme, query string, or fragment. See [Purge cache by prefix](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByPrefixes / titleRemoved value: -"Purge by prefixes" - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByPrefixes / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByTags / $refAdded value: +"#/$defs/cache-purge_FlexPurgeByTags" - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByTags / propertiesRemoved value: -{ - "tags": { - "description": "Cache tags. Targets all content whose `Cache-Tag` response header contains at least one of these tags. See [Purge cache by cache-tags](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByTags / titleRemoved value: -"Purge by tags" - removed
Input schema / properties / payload / $defs / cache-purge_FlexPurgeByTags / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / cache-purge_SingleFile / $refAdded value: +"#/$defs/cache-purge_SingleFile" - removed
Input schema / properties / payload / $defs / cache-purge_SingleFile / propertiesRemoved value: -{ - "files": { - "description": "Full URLs, such as `https://www.example.com/css/styles.css`. Targets the content cached for each URL. If your cache key includes request headers, send objects with `url` and `headers` instead. See [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).", - "items": { - "type": "string" - }, - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / cache-purge_SingleFile / titleRemoved value: -"Purge files" - removed
Input schema / properties / payload / $defs / cache-purge_SingleFile / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / cache-purge_SingleFileWithUrlAndHeaders / $refAdded value: +"#/$defs/cache-purge_SingleFileWithUrlAndHeaders" - removed
Input schema / properties / payload / $defs / cache-purge_SingleFileWithUrlAndHeaders / propertiesRemoved value: -{ - "files": { - "description": "URLs with the request headers your cache key uses. Use this form when your cache key includes request headers, or the visitor's device type, country, or language: send the header values each URL was cached with, such as `CF-Device-Type`, `CF-IPCountry`, or `Accept-Language`.\n\nWhen you send the `Origin` header, include the scheme and hostname. Include the port unless it is the default for the scheme: 80 for `http`, 443 for `https`.\n\nSee [Purge by single-file](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).\n", - "items": { - "properties": { - "headers": { - "additionalProperties": { - "type": "string" - }, - "description": "Request headers and the values the content was cached with.", - "type": "object" - }, - "url": { - "description": "Full URL of the content.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / cache-purge_SingleFileWithUrlAndHeaders / titleRemoved value: -"Purge files with URL and headers" - removed
Input schema / properties / payload / $defs / cache-purge_SingleFileWithUrlAndHeaders / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / cache-purge_identifier / $refAdded value: +"#/$defs/cache-purge_identifier" - removed
Input schema / properties / payload / $defs / cache-purge_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / cache-purge_identifier / typeRemoved value: -"string"
- Changed
update_dns_record129 fields changed- changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / dns-records_AAAARecord / $refAdded value: +"#/$defs/dns-records_AAAARecord" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv6 address.", - "format": "ipv6", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "AAAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / titleRemoved value: -"AAAA Record" - removed
Input schema / properties / payload / $defs / dns-records_AAAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_ARecord / $refAdded value: +"#/$defs/dns-records_ARecord" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid IPv4 address.", - "format": "ipv4", - "type": "string" - }, - "private_routing": { - "default": false, - "description": "Enables private network routing to the origin.", - "type": "boolean" - }, - "type": { - "description": "Record type.", - "enum": [ - "A" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ARecord / titleRemoved value: -"A Record" - removed
Input schema / properties / payload / $defs / dns-records_ARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CAARecord / $refAdded value: +"#/$defs/dns-records_CAARecord" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CAA content. See 'data' to set CAA properties.", - "type": "string" - }, - "data": { - "description": "Components of a CAA record.", - "properties": { - "flags": { - "description": "Flags for the CAA record.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "tag": { - "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", - "type": "string" - }, - "value": { - "description": "Value of the record. This field's semantics depend on the chosen tag.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CAA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / titleRemoved value: -"CAA Record" - removed
Input schema / properties / payload / $defs / dns-records_CAARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CERTRecord / $refAdded value: +"#/$defs/dns-records_CERTRecord" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted CERT content. See 'data' to set CERT properties.", - "type": "string" - }, - "data": { - "description": "Components of a CERT record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "type": { - "description": "Type.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CERT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / titleRemoved value: -"CERT Record" - removed
Input schema / properties / payload / $defs / dns-records_CERTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_CNAMERecord / $refAdded value: +"#/$defs/dns-records_CNAMERecord" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid hostname. Must not match the record's name.", - "type": "string" - }, - "settings": { - "properties": { - "flatten_cname": { - "default": false, - "description": "If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "CNAME" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / titleRemoved value: -"CNAME Record" - removed
Input schema / properties / payload / $defs / dns-records_CNAMERecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / $refAdded value: +"#/$defs/dns-records_DNSKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", - "type": "string" - }, - "data": { - "description": "Components of a DNSKEY record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "flags": { - "description": "Flags.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "protocol": { - "description": "Protocol.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "public_key": { - "description": "Public Key.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DNSKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / titleRemoved value: -"DNSKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_DNSKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_DSRecord / $refAdded value: +"#/$defs/dns-records_DSRecord" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted DS content. See 'data' to set DS properties.", - "type": "string" - }, - "data": { - "description": "Components of a DS record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "digest": { - "description": "Digest.", - "type": "string" - }, - "digest_type": { - "description": "Digest Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "key_tag": { - "description": "Key Tag.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "DS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / titleRemoved value: -"DS Record" - removed
Input schema / properties / payload / $defs / dns-records_DSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / $refAdded value: +"#/$defs/dns-records_HTTPSRecord" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", - "type": "string" - }, - "data": { - "description": "Components of a HTTPS record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "HTTPS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / titleRemoved value: -"HTTPS Record" - removed
Input schema / properties / payload / $defs / dns-records_HTTPSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_LOCRecord / $refAdded value: +"#/$defs/dns-records_LOCRecord" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted LOC content. See 'data' to set LOC properties.", - "type": "string" - }, - "data": { - "description": "Components of a LOC record.", - "properties": { - "altitude": { - "description": "Altitude of location in meters.", - "maximum": 42849672.95, - "minimum": -100000, - "type": "number" - }, - "lat_degrees": { - "description": "Degrees of latitude.", - "maximum": 90, - "minimum": 0, - "type": "number" - }, - "lat_direction": { - "description": "Latitude direction.", - "enum": [ - "N", - "S" - ], - "type": "string" - }, - "lat_minutes": { - "description": "Minutes of latitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "lat_seconds": { - "description": "Seconds of latitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "long_degrees": { - "description": "Degrees of longitude.", - "maximum": 180, - "minimum": 0, - "type": "number" - }, - "long_direction": { - "description": "Longitude direction.", - "enum": [ - "E", - "W" - ], - "type": "string" - }, - "long_minutes": { - "description": "Minutes of longitude.", - "maximum": 59, - "minimum": 0, - "type": "number" - }, - "long_seconds": { - "description": "Seconds of longitude.", - "maximum": 59.999, - "minimum": 0, - "type": "number" - }, - "precision_horz": { - "description": "Horizontal precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "precision_vert": { - "description": "Vertical precision of location.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - }, - "size": { - "description": "Size of location in meters.", - "maximum": 90000000, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "LOC" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / titleRemoved value: -"LOC Record" - removed
Input schema / properties / payload / $defs / dns-records_LOCRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_MXRecord / $refAdded value: +"#/$defs/dns-records_MXRecord" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid mail server hostname.", - "format": "hostname", - "type": "string" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "MX" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / titleRemoved value: -"MX Record" - removed
Input schema / properties / payload / $defs / dns-records_MXRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / $refAdded value: +"#/$defs/dns-records_NAPTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", - "type": "string" - }, - "data": { - "description": "Components of a NAPTR record.", - "properties": { - "flags": { - "description": "Flags.", - "type": "string" - }, - "order": { - "description": "Order.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "preference": { - "description": "Preference.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "regex": { - "description": "Regex.", - "type": "string" - }, - "replacement": { - "description": "Replacement.", - "type": "string" - }, - "service": { - "description": "Service.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "NAPTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / titleRemoved value: -"NAPTR Record" - removed
Input schema / properties / payload / $defs / dns-records_NAPTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_NSRecord / $refAdded value: +"#/$defs/dns-records_NSRecord" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A valid name server host name.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "NS" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / titleRemoved value: -"NS Record" - removed
Input schema / properties / payload / $defs / dns-records_NSRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / $refAdded value: +"#/$defs/dns-records_OPENPGPKEYRecord" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "OPENPGPKEY" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / titleRemoved value: -"OPENPGPKEY Record" - removed
Input schema / properties / payload / $defs / dns-records_OPENPGPKEYRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_PTRRecord / $refAdded value: +"#/$defs/dns-records_PTRRecord" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Domain name pointing to the address.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "PTR" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / titleRemoved value: -"PTR Record" - removed
Input schema / properties / payload / $defs / dns-records_PTRRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / $refAdded value: +"#/$defs/dns-records_SMIMEARecord" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", - "type": "string" - }, - "data": { - "description": "Components of a SMIMEA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SMIMEA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / titleRemoved value: -"SMIMEA Record" - removed
Input schema / properties / payload / $defs / dns-records_SMIMEARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SRVRecord / $refAdded value: +"#/$defs/dns-records_SRVRecord" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", - "type": "string" - }, - "data": { - "description": "Components of a SRV record.", - "properties": { - "port": { - "description": "The port of the service.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "target": { - "description": "A valid hostname.", - "format": "hostname", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SRV" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / titleRemoved value: -"SRV Record" - removed
Input schema / properties / payload / $defs / dns-records_SRVRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / $refAdded value: +"#/$defs/dns-records_SSHFPRecord" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", - "type": "string" - }, - "data": { - "description": "Components of a SSHFP record.", - "properties": { - "algorithm": { - "description": "Algorithm.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "fingerprint": { - "description": "Fingerprint.", - "type": "string" - }, - "type": { - "description": "Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SSHFP" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / titleRemoved value: -"SSHFP Record" - removed
Input schema / properties / payload / $defs / dns-records_SSHFPRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_SVCBRecord / $refAdded value: +"#/$defs/dns-records_SVCBRecord" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted SVCB content. See 'data' to set SVCB properties.", - "type": "string" - }, - "data": { - "description": "Components of a SVCB record.", - "properties": { - "priority": { - "description": "Priority.", - "maximum": 65535, - "minimum": 0, - "type": "number" - }, - "target": { - "description": "Target.", - "type": "string" - }, - "value": { - "description": "Value.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "SVCB" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / titleRemoved value: -"SVCB Record" - removed
Input schema / properties / payload / $defs / dns-records_SVCBRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TLSARecord / $refAdded value: +"#/$defs/dns-records_TLSARecord" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted TLSA content. See 'data' to set TLSA properties.", - "type": "string" - }, - "data": { - "description": "Components of a TLSA record.", - "properties": { - "certificate": { - "description": "Certificate.", - "type": "string" - }, - "matching_type": { - "description": "Matching Type.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "selector": { - "description": "Selector.", - "maximum": 255, - "minimum": 0, - "type": "number" - }, - "usage": { - "description": "Usage.", - "maximum": 255, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "type": { - "description": "Record type.", - "enum": [ - "TLSA" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / titleRemoved value: -"TLSA Record" - removed
Input schema / properties / payload / $defs / dns-records_TLSARecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_TXTRecord / $refAdded value: +"#/$defs/dns-records_TXTRecord" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at <https://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/>.", - "type": "string" - }, - "type": { - "description": "Record type.", - "enum": [ - "TXT" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / titleRemoved value: -"TXT Record" - removed
Input schema / properties / payload / $defs / dns-records_TXTRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_URIRecord / $refAdded value: +"#/$defs/dns-records_URIRecord" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / allOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_dns-record-shared-fields" - }, - { - "properties": { - "content": { - "description": "Formatted URI content. See 'data' to set URI properties.", - "type": "string" - }, - "data": { - "description": "Components of a URI record.", - "properties": { - "target": { - "description": "The record content.", - "type": "string" - }, - "weight": { - "description": "The record weight.", - "maximum": 65535, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "priority": { - "$ref": "#/$defs/dns-records_priority" - }, - "type": { - "description": "Record type.", - "enum": [ - "URI" - ], - "type": "string" - } - }, - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / titleRemoved value: -"URI Record" - removed
Input schema / properties / payload / $defs / dns-records_URIRecord / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_comment / $refAdded value: +"#/$defs/dns-records_comment" - removed
Input schema / properties / payload / $defs / dns-records_comment / descriptionRemoved value: -"Comments or notes about the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_comment / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / $refAdded value: +"#/$defs/dns-records_dns-record-shared-fields" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / propertiesRemoved value: -{ - "comment": { - "$ref": "#/$defs/dns-records_comment" - }, - "name": { - "$ref": "#/$defs/dns-records_name" - }, - "proxied": { - "$ref": "#/$defs/dns-records_proxied" - }, - "settings": { - "$ref": "#/$defs/dns-records_settings" - }, - "tags": { - "$ref": "#/$defs/dns-records_tags" - }, - "ttl": { - "$ref": "#/$defs/dns-records_ttl" - } -} - removed
Input schema / properties / payload / $defs / dns-records_dns-record-shared-fields / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / $refAdded value: +"#/$defs/dns-records_dns-record-with-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_CAARecord" - }, - { - "$ref": "#/$defs/dns-records_CERTRecord" - }, - { - "$ref": "#/$defs/dns-records_DNSKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_DSRecord" - }, - { - "$ref": "#/$defs/dns-records_HTTPSRecord" - }, - { - "$ref": "#/$defs/dns-records_LOCRecord" - }, - { - "$ref": "#/$defs/dns-records_NAPTRRecord" - }, - { - "$ref": "#/$defs/dns-records_SMIMEARecord" - }, - { - "$ref": "#/$defs/dns-records_SRVRecord" - }, - { - "$ref": "#/$defs/dns-records_SSHFPRecord" - }, - { - "$ref": "#/$defs/dns-records_SVCBRecord" - }, - { - "$ref": "#/$defs/dns-records_TLSARecord" - }, - { - "$ref": "#/$defs/dns-records_URIRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-with-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / $refAdded value: +"#/$defs/dns-records_dns-record-without-data" - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / oneOfRemoved value: -[ - { - "$ref": "#/$defs/dns-records_ARecord" - }, - { - "$ref": "#/$defs/dns-records_AAAARecord" - }, - { - "$ref": "#/$defs/dns-records_CNAMERecord" - }, - { - "$ref": "#/$defs/dns-records_MXRecord" - }, - { - "$ref": "#/$defs/dns-records_NSRecord" - }, - { - "$ref": "#/$defs/dns-records_OPENPGPKEYRecord" - }, - { - "$ref": "#/$defs/dns-records_PTRRecord" - }, - { - "$ref": "#/$defs/dns-records_TXTRecord" - } -] - removed
Input schema / properties / payload / $defs / dns-records_dns-record-without-data / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_identifier / $refAdded value: +"#/$defs/dns-records_identifier" - removed
Input schema / properties / payload / $defs / dns-records_identifier / descriptionRemoved value: -"Identifier." - removed
Input schema / properties / payload / $defs / dns-records_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / dns-records_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_name / $refAdded value: +"#/$defs/dns-records_name" - removed
Input schema / properties / payload / $defs / dns-records_name / descriptionRemoved value: -"Complete DNS record name, including the zone name, in Punycode." - removed
Input schema / properties / payload / $defs / dns-records_name / maxLengthRemoved value: -255 - removed
Input schema / properties / payload / $defs / dns-records_name / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / dns-records_priority / $refAdded value: +"#/$defs/dns-records_priority" - removed
Input schema / properties / payload / $defs / dns-records_priority / descriptionRemoved value: -"Required for MX and URI records; ignored for other record types (but may still be returned by the API). Records with lower priorities are preferred. This field is to be deprecated in favor of the priority field within the data map." - removed
Input schema / properties / payload / $defs / dns-records_priority / maximumRemoved value: -65535 - removed
Input schema / properties / payload / $defs / dns-records_priority / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / dns-records_priority / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / dns-records_proxied / $refAdded value: +"#/$defs/dns-records_proxied" - removed
Input schema / properties / payload / $defs / dns-records_proxied / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / dns-records_proxied / descriptionRemoved value: -"Whether the record is receiving the performance and security benefits of Cloudflare." - removed
Input schema / properties / payload / $defs / dns-records_proxied / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / dns-records_settings / $refAdded value: +"#/$defs/dns-records_settings" - removed
Input schema / properties / payload / $defs / dns-records_settings / descriptionRemoved value: -"Settings for the DNS record." - removed
Input schema / properties / payload / $defs / dns-records_settings / propertiesRemoved value: -{ - "ipv4_only": { - "default": false, - "description": "When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - }, - "ipv6_only": { - "default": false, - "description": "When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / dns-records_settings / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / dns-records_tags / $refAdded value: +"#/$defs/dns-records_tags" - removed
Input schema / properties / payload / $defs / dns-records_tags / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / dns-records_tags / descriptionRemoved value: -"Custom tags for the DNS record. This field has no effect on DNS responses." - removed
Input schema / properties / payload / $defs / dns-records_tags / itemsRemoved value: -{ - "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", - "type": "string" -} - removed
Input schema / properties / payload / $defs / dns-records_tags / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / dns-records_ttl / $refAdded value: +"#/$defs/dns-records_ttl" - removed
Input schema / properties / payload / $defs / dns-records_ttl / anyOfRemoved value: -[ - { - "maximum": 86400, - "minimum": 30, - "type": "number" - }, - { - "enum": [ - 1 - ], - "type": "number" - } -] - removed
Input schema / properties / payload / $defs / dns-records_ttl / defaultRemoved value: -1 - removed
Input schema / properties / payload / $defs / dns-records_ttl / descriptionRemoved value: -"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones." - removed
Input schema / properties / payload / $defs / dns-records_ttl / typeRemoved value: -"number"
- Changed
update_zone_ruleset503 fields changed- added
Input schema / $defs / Remove_DirectiveAdded value: +{ + "description": "Remove the directive.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "remove" + ], + "type": "string" + } + ] + } + }, + "required": [ + "operation" + ], + "title": "Remove Directive", + "type": "object" +} - changed
Input schema / $defs / rulesets_SetCacheControlDirective / oneOfPrevious value: -[ - { - "description": "Set the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -]New value: +[ + { + "description": "Set the directive.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "set" + ], + "type": "string" + } + ] + } + }, + "required": [ + "operation" + ], + "title": "Set Directive", + "type": "object" + }, + { + "$ref": "#/$defs/Remove_Directive" + } +] - changed
Input schema / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / oneOfPrevious value: -[ - { - "description": "Set the directive with optional qualifiers.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "qualifiers": { - "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).", - "items": { - "description": "A header name to qualify the directive.", - "minLength": 1, - "title": "Qualifier", - "type": "string" - }, - "title": "Qualifiers", - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -]New value: +[ + { + "description": "Set the directive with optional qualifiers.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "set" + ], + "type": "string" + } + ] + }, + "qualifiers": { + "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).", + "items": { + "description": "A header name to qualify the directive.", + "minLength": 1, + "title": "Qualifier", + "type": "string" + }, + "title": "Qualifiers", + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "operation" + ], + "title": "Set Directive", + "type": "object" + }, + { + "$ref": "#/$defs/Remove_Directive" + } +] - changed
Input schema / $defs / rulesets_SetCacheControlDirectiveWithValue / oneOfPrevious value: -[ - { - "description": "Set the directive with a duration value in seconds.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "value": { - "description": "The duration value in seconds for the directive.", - "minimum": 0, - "title": "Value", - "type": "integer" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -]New value: +[ + { + "description": "Set the directive with a duration value in seconds.", + "properties": { + "cloudflare_only": { + "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" + }, + "operation": { + "allOf": [ + { + "$ref": "#/$defs/rulesets_SetCacheControlOperation" + }, + { + "enum": [ + "set" + ], + "type": "string" + } + ] + }, + "value": { + "description": "The duration value in seconds for the directive.", + "minimum": 0, + "title": "Value", + "type": "integer" + } + }, + "required": [ + "operation", + "value" + ], + "title": "Set Directive", + "type": "object" + }, + { + "$ref": "#/$defs/Remove_Directive" + } +] - changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / rulesets_BlockRule / $refAdded value: +"#/$defs/rulesets_BlockRule" - removed
Input schema / properties / payload / $defs / rulesets_BlockRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "block" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "response": { - "description": "The response to show when the block is applied.", - "properties": { - "content": { - "description": "The content to return.", - "minLength": 1, - "title": "Content", - "type": "string" - }, - "content_type": { - "description": "The type of the content to return.", - "minLength": 1, - "title": "Content Type", - "type": "string" - }, - "status_code": { - "description": "The status code to return.", - "maximum": 499, - "minimum": 400, - "title": "Status Code", - "type": "integer" - } - }, - "required": [ - "status_code", - "content", - "content_type" - ], - "title": "Response", - "type": "object" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Block Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ChallengeRule / $refAdded value: +"#/$defs/rulesets_ChallengeRule" - removed
Input schema / properties / payload / $defs / rulesets_ChallengeRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "challenge" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Challenge Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_CompressResponseRule / $refAdded value: +"#/$defs/rulesets_CompressResponseRule" - removed
Input schema / properties / payload / $defs / rulesets_CompressResponseRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "compress_response" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "algorithms": { - "description": "Custom order for compression algorithms.", - "items": { - "description": "Compression algorithm to enable.", - "properties": { - "name": { - "description": "Name of the compression algorithm to enable.", - "enum": [ - "none", - "auto", - "default", - "gzip", - "brotli", - "zstd" - ], - "title": "Algorithm Name", - "type": "string" - } - }, - "title": "Algorithm", - "type": "object" - }, - "minItems": 1, - "title": "Algorithms", - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "algorithms" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Response Compression Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_DDoSDynamicRule / $refAdded value: +"#/$defs/rulesets_DDoSDynamicRule" - removed
Input schema / properties / payload / $defs / rulesets_DDoSDynamicRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "ddos_dynamic" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "DDoS Dynamic Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / $refAdded value: +"#/$defs/rulesets_ExecuteCategoryOverrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / descriptionRemoved value: -"A list of category-level overrides. This option has the second-highest precedence after rule-level overrides." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / itemsRemoved value: -{ - "description": "A category-level override.", - "minProperties": 2, - "properties": { - "action": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleAction" - }, - { - "description": "The action to override rules in the category with.", - "type": "string" - } - ] - }, - "category": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleCategory" - }, - { - "description": "The name of the category to override.", - "type": "string" - } - ] - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "description": "Whether to enable execution of rules in the category.", - "type": "boolean" - } - ] - }, - "sensitivity_level": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel" - }, - { - "description": "The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases.", - "type": "string" - } - ] - } - }, - "required": [ - "category" - ], - "title": "Category Override", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / titleRemoved value: -"Category Overrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteCategoryOverrides / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / $refAdded value: +"#/$defs/rulesets_ExecuteMatchedData" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / descriptionRemoved value: -"The configuration to use for matched data logging." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / propertiesRemoved value: -{ - "public_key": { - "description": "The public key to encrypt matched data logs with.", - "minLength": 1, - "title": "Public Key", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / requiredRemoved value: -[ - "public_key" -] - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / titleRemoved value: -"Matched Data" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteMatchedData / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / $refAdded value: +"#/$defs/rulesets_ExecuteOverrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / descriptionRemoved value: -"A set of overrides to apply to the target ruleset." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / propertiesRemoved value: -{ - "action": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleAction" - }, - { - "description": "An action to override all rules with. This option has lower precedence than rule and category overrides.", - "type": "string" - } - ] - }, - "categories": { - "$ref": "#/$defs/rulesets_ExecuteCategoryOverrides" - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "description": "Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.", - "type": "boolean" - } - ] - }, - "rules": { - "$ref": "#/$defs/rulesets_ExecuteRuleOverrides" - }, - "sensitivity_level": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel" - }, - { - "description": "A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.", - "type": "string" - } - ] - } -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / titleRemoved value: -"Overrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteOverrides / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_ExecuteRule / $refAdded value: +"#/$defs/rulesets_ExecuteRule" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "execute" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "id": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetId" - }, - { - "description": "The ID of the ruleset to execute.", - "type": "string" - } - ] - }, - "matched_data": { - "$ref": "#/$defs/rulesets_ExecuteMatchedData" - }, - "overrides": { - "$ref": "#/$defs/rulesets_ExecuteOverrides" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Execute Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / $refAdded value: +"#/$defs/rulesets_ExecuteRuleOverrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / descriptionRemoved value: -"A list of rule-level overrides. This option has the highest precedence." - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / itemsRemoved value: -{ - "description": "A rule-level override.", - "minProperties": 2, - "properties": { - "action": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleAction" - }, - { - "description": "The action to override the rule with.", - "type": "string" - } - ] - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "description": "Whether to enable execution of the rule.", - "type": "boolean" - } - ] - }, - "id": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleId" - }, - { - "description": "The ID of the rule to override.", - "type": "string" - } - ] - }, - "score_threshold": { - "description": "The score threshold to use for the rule.", - "title": "Score Threshold", - "type": "integer" - }, - "sensitivity_level": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_ExecuteSensitivityLevel" - }, - { - "description": "The sensitivity level to use for the rule. This option is only applicable for DDoS phases.", - "type": "string" - } - ] - } - }, - "required": [ - "id" - ], - "title": "Rule Override", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / titleRemoved value: -"Rule Overrides" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteRuleOverrides / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / $refAdded value: +"#/$defs/rulesets_ExecuteSensitivityLevel" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / enumRemoved value: -[ - "default", - "medium", - "low", - "eoff" -] - removed
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / titleRemoved value: -"Sensitivity Level" - removed
Input schema / properties / payload / $defs / rulesets_ExecuteSensitivityLevel / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ForceConnectionCloseRule / $refAdded value: +"#/$defs/rulesets_ForceConnectionCloseRule" - removed
Input schema / properties / payload / $defs / rulesets_ForceConnectionCloseRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "force_connection_close" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Force Connection Close Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_JsChallengeRule / $refAdded value: +"#/$defs/rulesets_JsChallengeRule" - removed
Input schema / properties / payload / $defs / rulesets_JsChallengeRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "js_challenge" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "JavaScript Challenge Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldCookieFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / descriptionRemoved value: -"The cookie fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / itemsRemoved value: -{ - "description": "The cookie field to log.", - "properties": { - "name": { - "description": "The name of the cookie.", - "minLength": 1, - "title": "Cookie Name", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "Cookie Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / titleRemoved value: -"Cookie Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldCookieFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldRawResponseFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / descriptionRemoved value: -"The raw response fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / itemsRemoved value: -{ - "description": "The raw response field to log.", - "properties": { - "name": { - "description": "The name of the response header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - }, - "preserve_duplicates": { - "default": false, - "description": "Whether to log duplicate values of the same header.", - "title": "Preserve Duplicates", - "type": "boolean" - } - }, - "required": [ - "name" - ], - "title": "Raw Response Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / titleRemoved value: -"Raw Response Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRawResponseFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldRequestFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / descriptionRemoved value: -"The raw request fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / itemsRemoved value: -{ - "description": "The raw request field to log.", - "properties": { - "name": { - "description": "The name of the header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "Raw Request Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / titleRemoved value: -"Raw Request Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRequestFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldResponseFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / descriptionRemoved value: -"The transformed response fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / itemsRemoved value: -{ - "description": "The transformed response field to log.", - "properties": { - "name": { - "description": "The name of the response header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - }, - "preserve_duplicates": { - "default": false, - "description": "Whether to log duplicate values of the same header.", - "title": "Preserve Duplicates", - "type": "boolean" - } - }, - "required": [ - "name" - ], - "title": "Transformed Response Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / titleRemoved value: -"Transformed Response Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldResponseFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRule / $refAdded value: +"#/$defs/rulesets_LogCustomFieldRule" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "log_custom_field" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "cookie_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldCookieFields" - }, - "raw_response_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldRawResponseFields" - }, - "request_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldRequestFields" - }, - "response_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldResponseFields" - }, - "transformed_request_fields": { - "$ref": "#/$defs/rulesets_LogCustomFieldTransformedRequestFields" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Log Custom Field Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / $refAdded value: +"#/$defs/rulesets_LogCustomFieldTransformedRequestFields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / descriptionRemoved value: -"The transformed request fields to log." - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / itemsRemoved value: -{ - "description": "The transformed request field to log.", - "properties": { - "name": { - "description": "The name of the header.", - "minLength": 1, - "title": "Header Name", - "type": "string" - } - }, - "required": [ - "name" - ], - "title": "Transformed Request Field", - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / titleRemoved value: -"Transformed Request Fields" - removed
Input schema / properties / payload / $defs / rulesets_LogCustomFieldTransformedRequestFields / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_LogRule / $refAdded value: +"#/$defs/rulesets_LogRule" - removed
Input schema / properties / payload / $defs / rulesets_LogRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "log" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Log Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ManagedChallengeRule / $refAdded value: +"#/$defs/rulesets_ManagedChallengeRule" - removed
Input schema / properties / payload / $defs / rulesets_ManagedChallengeRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "managed_challenge" - ], - "type": "string" - }, - "description": { - "type": "string" - } - }, - "title": "Managed Challenge Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RedirectFromList / $refAdded value: +"#/$defs/rulesets_RedirectFromList" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / descriptionRemoved value: -"A redirect based on a bulk list lookup." - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / propertiesRemoved value: -{ - "key": { - "description": "An expression that evaluates to the list lookup key.", - "minLength": 1, - "title": "Lookup Key", - "type": "string" - }, - "name": { - "description": "The name of the list to match against.", - "pattern": "^[a-zA-Z0-9_]+$", - "title": "List Name", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / requiredRemoved value: -[ - "name", - "key" -] - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / titleRemoved value: -"Bulk Redirect" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromList / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / $refAdded value: +"#/$defs/rulesets_RedirectFromValue" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / descriptionRemoved value: -"A redirect based on the request properties." - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / propertiesRemoved value: -{ - "preserve_query_string": { - "default": false, - "description": "Whether to keep the query string of the original request.", - "title": "Preserve Query String", - "type": "boolean" - }, - "status_code": { - "description": "The status code to use for the redirect.", - "enum": [ - 301, - 302, - 303, - 307, - 308 - ], - "title": "Status Code", - "type": "integer" - }, - "target_url": { - "description": "A URL to redirect the request to.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "expression": { - "description": "An expression that evaluates to a URL to redirect the request to.", - "minLength": 1, - "title": "Redirect Expression", - "type": "string" - }, - "value": { - "description": "A URL to redirect the request to.", - "minLength": 1, - "title": "Redirect Value", - "type": "string" - } - }, - "title": "Target URL", - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / requiredRemoved value: -[ - "target_url" -] - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / titleRemoved value: -"Single Redirect" - removed
Input schema / properties / payload / $defs / rulesets_RedirectFromValue / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RedirectRule / $refAdded value: +"#/$defs/rulesets_RedirectRule" - removed
Input schema / properties / payload / $defs / rulesets_RedirectRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "redirect" - ], - "type": "string" - }, - "action_parameters": { - "maxProperties": 1, - "minProperties": 1, - "properties": { - "from_list": { - "$ref": "#/$defs/rulesets_RedirectFromList" - }, - "from_value": { - "$ref": "#/$defs/rulesets_RedirectFromValue" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Redirect Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RequestRule / $refAdded value: +"#/$defs/rulesets_RequestRule" - removed
Input schema / properties / payload / $defs / rulesets_RequestRule / oneOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_BlockRule" - }, - { - "$ref": "#/$defs/rulesets_ChallengeRule" - }, - { - "$ref": "#/$defs/rulesets_CompressResponseRule" - }, - { - "$ref": "#/$defs/rulesets_DDoSDynamicRule" - }, - { - "$ref": "#/$defs/rulesets_ExecuteRule" - }, - { - "$ref": "#/$defs/rulesets_ForceConnectionCloseRule" - }, - { - "$ref": "#/$defs/rulesets_JsChallengeRule" - }, - { - "$ref": "#/$defs/rulesets_LogRule" - }, - { - "$ref": "#/$defs/rulesets_LogCustomFieldRule" - }, - { - "$ref": "#/$defs/rulesets_ManagedChallengeRule" - }, - { - "$ref": "#/$defs/rulesets_RedirectRule" - }, - { - "$ref": "#/$defs/rulesets_RewriteRule" - }, - { - "$ref": "#/$defs/rulesets_RouteRule" - }, - { - "$ref": "#/$defs/rulesets_ScoreRule" - }, - { - "$ref": "#/$defs/rulesets_ServeErrorRule" - }, - { - "$ref": "#/$defs/rulesets_SetCacheControlRule" - }, - { - "$ref": "#/$defs/rulesets_SetCacheSettingsRule" - }, - { - "$ref": "#/$defs/rulesets_SetCacheTagsRule" - }, - { - "$ref": "#/$defs/rulesets_SetConfigRule" - }, - { - "$ref": "#/$defs/rulesets_SkipRule" - }, - { - "$ref": "#/$defs/rulesets_TransformResponseHTMLRule" - } -] - added
Input schema / properties / payload / $defs / rulesets_RequestRules / $refAdded value: +"#/$defs/rulesets_RequestRules" - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / descriptionRemoved value: -"The list of rules in the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / itemsRemoved value: -{ - "$ref": "#/$defs/rulesets_RequestRule" -} - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / titleRemoved value: -"Rules" - removed
Input schema / properties / payload / $defs / rulesets_RequestRules / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / $refAdded value: +"#/$defs/rulesets_RewriteHeaderExpression" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / descriptionRemoved value: -"An expression that evaluates to a value for the header." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / titleRemoved value: -"Header Expression" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderExpression / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / $refAdded value: +"#/$defs/rulesets_RewriteHeaderOperation" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / descriptionRemoved value: -"The operation to perform on the header." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / titleRemoved value: -"Operation" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderOperation / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / $refAdded value: +"#/$defs/rulesets_RewriteHeaderValue" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / descriptionRemoved value: -"A static value for the header." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / titleRemoved value: -"Header Value" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaderValue / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / $refAdded value: +"#/$defs/rulesets_RewriteHeaders" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / additionalPropertiesRemoved value: -{ - "oneOf": [ - { - "description": "A header with a static value to add.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - }, - "value": { - "$ref": "#/$defs/rulesets_RewriteHeaderValue" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Add Static Header", - "type": "object" - }, - { - "description": "A header with a dynamic value to add.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_RewriteHeaderExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Add Dynamic Header", - "type": "object" - }, - { - "description": "A header with a static value to set.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "value": { - "$ref": "#/$defs/rulesets_RewriteHeaderValue" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Set Static Header", - "type": "object" - }, - { - "description": "A header with a dynamic value to set.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_RewriteHeaderExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Set Dynamic Header", - "type": "object" - }, - { - "description": "A header to remove.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RewriteHeaderOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Header", - "type": "object" - } - ] -} - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / descriptionRemoved value: -"A map of headers to rewrite." - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / titleRemoved value: -"Headers" - removed
Input schema / properties / payload / $defs / rulesets_RewriteHeaders / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RewriteRule / $refAdded value: +"#/$defs/rulesets_RewriteRule" - removed
Input schema / properties / payload / $defs / rulesets_RewriteRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "rewrite" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "headers": { - "$ref": "#/$defs/rulesets_RewriteHeaders" - }, - "uri": { - "$ref": "#/$defs/rulesets_RewriteUri" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Rewrite Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RewriteUri / $refAdded value: +"#/$defs/rulesets_RewriteUri" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUri / allOfRemoved value: -[ - { - "anyOf": [ - { - "description": "A URI path rewrite.", - "properties": { - "path": { - "$ref": "#/$defs/rulesets_RewriteUriPath" - } - }, - "required": [ - "path" - ], - "title": "URI Path", - "type": "object" - }, - { - "description": "A URI query rewrite.", - "properties": { - "query": { - "$ref": "#/$defs/rulesets_RewriteUriQuery" - } - }, - "required": [ - "query" - ], - "title": "URI Query", - "type": "object" - } - ] - }, - { - "properties": { - "origin": { - "description": "Whether to propagate the rewritten URI to origin.", - "title": "Origin", - "type": "boolean" - } - }, - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / $refAdded value: +"#/$defs/rulesets_RewriteUriPath" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / descriptionRemoved value: -"A URI path rewrite." - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / maxPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / propertiesRemoved value: -{ - "expression": { - "description": "An expression that evaluates to a value to rewrite the URI path to.", - "minLength": 1, - "title": "Path Expression", - "type": "string" - }, - "value": { - "description": "A value to rewrite the URI path to.", - "minLength": 1, - "title": "Path Value", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / titleRemoved value: -"URI Path" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriPath / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / $refAdded value: +"#/$defs/rulesets_RewriteUriQuery" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / descriptionRemoved value: -"A URI query rewrite." - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / maxPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / propertiesRemoved value: -{ - "expression": { - "description": "An expression that evaluates to a value to rewrite the URI query to.", - "minLength": 1, - "title": "Query Expression", - "type": "string" - }, - "value": { - "description": "A value to rewrite the URI query to.", - "title": "Query Value", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / titleRemoved value: -"URI Query" - removed
Input schema / properties / payload / $defs / rulesets_RewriteUriQuery / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / $refAdded value: +"#/$defs/rulesets_RouteHostHeader" - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / descriptionRemoved value: -"A value to rewrite the HTTP host header to." - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / titleRemoved value: -"Host Header" - removed
Input schema / properties / payload / $defs / rulesets_RouteHostHeader / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RouteOrigin / $refAdded value: +"#/$defs/rulesets_RouteOrigin" - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / descriptionRemoved value: -"An origin to route to." - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / propertiesRemoved value: -{ - "host": { - "description": "A resolved host to route to.", - "minLength": 1, - "title": "Host", - "type": "string" - }, - "port": { - "description": "A destination port to route to.", - "maximum": 65535, - "minimum": 1, - "title": "Port", - "type": "integer" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / titleRemoved value: -"Origin" - removed
Input schema / properties / payload / $defs / rulesets_RouteOrigin / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RouteRule / $refAdded value: +"#/$defs/rulesets_RouteRule" - removed
Input schema / properties / payload / $defs / rulesets_RouteRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "route" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "host_header": { - "$ref": "#/$defs/rulesets_RouteHostHeader" - }, - "origin": { - "$ref": "#/$defs/rulesets_RouteOrigin" - }, - "sni": { - "$ref": "#/$defs/rulesets_RouteSNI" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Route Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_RouteSNI / $refAdded value: +"#/$defs/rulesets_RouteSNI" - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / descriptionRemoved value: -"A Server Name Indication (SNI) override." - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / propertiesRemoved value: -{ - "value": { - "description": "A value to override the SNI to.", - "minLength": 1, - "title": "Value", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / requiredRemoved value: -[ - "value" -] - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / titleRemoved value: -"Server Name Indication" - removed
Input schema / properties / payload / $defs / rulesets_RouteSNI / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_Rule / $refAdded value: +"#/$defs/rulesets_Rule" - removed
Input schema / properties / payload / $defs / rulesets_Rule / propertiesRemoved value: -{ - "action": { - "$ref": "#/$defs/rulesets_RuleAction" - }, - "action_parameters": { - "default": {}, - "description": "The parameters configuring the rule's action.", - "title": "Action Parameters", - "type": "object" - }, - "categories": { - "$ref": "#/$defs/rulesets_RuleCategories" - }, - "description": { - "default": "", - "description": "An informative description of the rule.", - "title": "Description", - "type": "string" - }, - "enabled": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleEnabled" - }, - { - "default": true, - "type": "boolean" - } - ] - }, - "exposed_credential_check": { - "$ref": "#/$defs/rulesets_RuleExposedCredentialCheck" - }, - "expression": { - "description": "The expression defining which traffic will match the rule.", - "minLength": 1, - "title": "Expression", - "type": "string" - }, - "id": { - "$ref": "#/$defs/rulesets_RuleId" - }, - "last_updated": { - "description": "The timestamp of when the rule was last modified.", - "format": "date-time", - "title": "Last Updated", - "type": "string" - }, - "logging": { - "$ref": "#/$defs/rulesets_RuleLogging" - }, - "ratelimit": { - "$ref": "#/$defs/rulesets_RuleRatelimit" - }, - "ref": { - "description": "The reference of the rule (the rule's ID by default).", - "minLength": 1, - "title": "Ref", - "type": "string" - }, - "version": { - "description": "The version of the rule.", - "pattern": "^[0-9]+$", - "title": "Version", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_Rule / requiredRemoved value: -[ - "version", - "last_updated" -] - removed
Input schema / properties / payload / $defs / rulesets_Rule / titleRemoved value: -"Rule" - removed
Input schema / properties / payload / $defs / rulesets_Rule / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RuleAction / $refAdded value: +"#/$defs/rulesets_RuleAction" - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / descriptionRemoved value: -"The action to perform when the rule matches." - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / patternRemoved value: -"^[a-z_]+$" - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / titleRemoved value: -"Action" - removed
Input schema / properties / payload / $defs / rulesets_RuleAction / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RuleCategories / $refAdded value: +"#/$defs/rulesets_RuleCategories" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / descriptionRemoved value: -"The categories of the rule." - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / itemsRemoved value: -{ - "$ref": "#/$defs/rulesets_RuleCategory" -} - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / titleRemoved value: -"Categories" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategories / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_RuleCategory / $refAdded value: +"#/$defs/rulesets_RuleCategory" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / descriptionRemoved value: -"The category of a rule." - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / titleRemoved value: -"Category" - removed
Input schema / properties / payload / $defs / rulesets_RuleCategory / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RuleEnabled / $refAdded value: +"#/$defs/rulesets_RuleEnabled" - removed
Input schema / properties / payload / $defs / rulesets_RuleEnabled / descriptionRemoved value: -"Whether the rule should be executed." - removed
Input schema / properties / payload / $defs / rulesets_RuleEnabled / titleRemoved value: -"Enabled" - removed
Input schema / properties / payload / $defs / rulesets_RuleEnabled / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / $refAdded value: +"#/$defs/rulesets_RuleExposedCredentialCheck" - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / descriptionRemoved value: -"Configuration for exposed credential checking." - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / propertiesRemoved value: -{ - "password_expression": { - "description": "An expression that selects the password used in the credentials check.", - "minLength": 1, - "title": "Password Expression", - "type": "string" - }, - "username_expression": { - "description": "An expression that selects the user ID used in the credentials check.", - "minLength": 1, - "title": "Username Expression", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / requiredRemoved value: -[ - "username_expression", - "password_expression" -] - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / titleRemoved value: -"Exposed Credential Check" - removed
Input schema / properties / payload / $defs / rulesets_RuleExposedCredentialCheck / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RuleId / $refAdded value: +"#/$defs/rulesets_RuleId" - removed
Input schema / properties / payload / $defs / rulesets_RuleId / descriptionRemoved value: -"The unique ID of the rule." - removed
Input schema / properties / payload / $defs / rulesets_RuleId / patternRemoved value: -"^[0-9a-f]{32}$" - removed
Input schema / properties / payload / $defs / rulesets_RuleId / titleRemoved value: -"Rule ID" - removed
Input schema / properties / payload / $defs / rulesets_RuleId / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RuleLogging / $refAdded value: +"#/$defs/rulesets_RuleLogging" - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / descriptionRemoved value: -"An object configuring the rule's logging behavior." - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / propertiesRemoved value: -{ - "enabled": { - "description": "Whether to generate a log when the rule matches.", - "title": "Enabled", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / requiredRemoved value: -[ - "enabled" -] - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / titleRemoved value: -"Logging" - removed
Input schema / properties / payload / $defs / rulesets_RuleLogging / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / $refAdded value: +"#/$defs/rulesets_RuleRatelimit" - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / descriptionRemoved value: -"An object configuring the rule's rate limit behavior." - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / propertiesRemoved value: -{ - "characteristics": { - "description": "Characteristics of the request on which the rate limit counter will be incremented.", - "items": { - "description": "The characteristic of the request.", - "minLength": 1, - "title": "Characteristic", - "type": "string" - }, - "minItems": 1, - "title": "Characteristics", - "type": "array", - "uniqueItems": true - }, - "counting_expression": { - "description": "An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.", - "minLength": 1, - "title": "Counting Expression", - "type": "string" - }, - "mitigation_timeout": { - "description": "Period of time in seconds after which the action will be disabled following its first execution.", - "title": "Mitigation Timeout", - "type": "integer" - }, - "period": { - "description": "Period in seconds over which the counter is being incremented.", - "minimum": 0, - "title": "Period", - "type": "integer" - }, - "requests_per_period": { - "description": "The threshold of requests per period after which the action will be executed for the first time.", - "minimum": 1, - "title": "Requests per Period", - "type": "integer" - }, - "requests_to_origin": { - "default": false, - "description": "Whether counting is only performed when an origin is reached.", - "title": "Requests to Origin", - "type": "boolean" - }, - "score_per_period": { - "description": "The score threshold per period for which the action will be executed the first time.", - "title": "Score per Period", - "type": "integer" - }, - "score_response_header_name": { - "description": "A response header name provided by the origin, which contains the score to increment rate limit counter with.", - "minLength": 1, - "title": "Score Response Header Name", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / requiredRemoved value: -[ - "characteristics", - "period" -] - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / titleRemoved value: -"Rate Limit" - removed
Input schema / properties / payload / $defs / rulesets_RuleRatelimit / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_Ruleset / $refAdded value: +"#/$defs/rulesets_Ruleset" - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / descriptionRemoved value: -"A ruleset object." - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / propertiesRemoved value: -{ - "description": { - "default": "", - "description": "An informative description of the ruleset.", - "title": "Description", - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetId" - }, - { - "type": "string" - } - ] - }, - "last_updated": { - "description": "The timestamp of when the ruleset was last modified.", - "format": "date-time", - "title": "Last Updated", - "type": "string" - }, - "name": { - "description": "The human-readable name of the ruleset.", - "minLength": 1, - "title": "Name", - "type": "string" - }, - "version": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetVersion" - }, - { - "type": "string" - } - ] - } -} - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / requiredRemoved value: -[ - "id", - "version", - "last_updated" -] - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / titleRemoved value: -"Ruleset" - removed
Input schema / properties / payload / $defs / rulesets_Ruleset / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_RulesetId / $refAdded value: +"#/$defs/rulesets_RulesetId" - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / descriptionRemoved value: -"The unique ID of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / patternRemoved value: -"^[0-9a-f]{32}$" - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / titleRemoved value: -"Ruleset ID" - removed
Input schema / properties / payload / $defs / rulesets_RulesetId / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RulesetKind / $refAdded value: +"#/$defs/rulesets_RulesetKind" - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / descriptionRemoved value: -"The kind of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / enumRemoved value: -[ - "managed", - "custom", - "root", - "zone" -] - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / titleRemoved value: -"Kind" - removed
Input schema / properties / payload / $defs / rulesets_RulesetKind / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RulesetPhase / $refAdded value: +"#/$defs/rulesets_RulesetPhase" - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / descriptionRemoved value: -"The phase of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / enumRemoved value: -[ - "ddos_l4", - "ddos_l7", - "http_config_settings", - "http_custom_errors", - "http_log_custom_fields", - "http_ratelimit", - "http_request_cache_settings", - "http_request_dynamic_redirect", - "http_request_firewall_custom", - "http_request_firewall_managed", - "http_request_late_transform", - "http_request_origin", - "http_request_redirect", - "http_request_sanitize", - "http_request_sbfm", - "http_request_transform", - "http_response_cache_settings", - "http_response_compression", - "http_response_firewall_managed", - "http_response_headers_transform", - "magic_transit", - "magic_transit_ids_managed", - "magic_transit_managed", - "magic_transit_ratelimit" -] - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / titleRemoved value: -"Phase" - removed
Input schema / properties / payload / $defs / rulesets_RulesetPhase / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_RulesetVersion / $refAdded value: +"#/$defs/rulesets_RulesetVersion" - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / descriptionRemoved value: -"The version of the ruleset." - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / patternRemoved value: -"^[0-9]+$" - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / titleRemoved value: -"Version" - removed
Input schema / properties / payload / $defs / rulesets_RulesetVersion / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / $refAdded value: +"#/$defs/rulesets_ScoreIncrement" - removed
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / descriptionRemoved value: -"A delta to change the score by, which can be either positive or negative." - removed
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / titleRemoved value: -"Increment" - removed
Input schema / properties / payload / $defs / rulesets_ScoreIncrement / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / rulesets_ScoreRule / $refAdded value: +"#/$defs/rulesets_ScoreRule" - removed
Input schema / properties / payload / $defs / rulesets_ScoreRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "score" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "increment": { - "$ref": "#/$defs/rulesets_ScoreIncrement" - } - }, - "required": [ - "increment" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Score Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / $refAdded value: +"#/$defs/rulesets_ServeErrorAssetName" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / descriptionRemoved value: -"The name of a custom asset to serve as the error response." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / titleRemoved value: -"Asset Name" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorAssetName / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / $refAdded value: +"#/$defs/rulesets_ServeErrorContent" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / descriptionRemoved value: -"The response content." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / titleRemoved value: -"Content" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContent / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / $refAdded value: +"#/$defs/rulesets_ServeErrorContentType" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / descriptionRemoved value: -"The content type header to set with the error response." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / enumRemoved value: -[ - "application/json", - "text/html", - "text/plain", - "text/xml" -] - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / titleRemoved value: -"Content Type" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorContentType / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_ServeErrorRule / $refAdded value: +"#/$defs/rulesets_ServeErrorRule" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "serve_error" - ], - "type": "string" - }, - "action_parameters": { - "allOf": [ - { - "properties": { - "content_type": { - "$ref": "#/$defs/rulesets_ServeErrorContentType" - }, - "status_code": { - "$ref": "#/$defs/rulesets_ServeErrorStatusCode" - } - }, - "required": [ - "content_type" - ], - "type": "object" - }, - { - "oneOf": [ - { - "properties": { - "content": { - "$ref": "#/$defs/rulesets_ServeErrorContent" - } - }, - "required": [ - "content" - ], - "title": "Action Parameters (Content)", - "type": "object" - }, - { - "properties": { - "asset_name": { - "$ref": "#/$defs/rulesets_ServeErrorAssetName" - } - }, - "required": [ - "asset_name" - ], - "title": "Action Parameters (Asset)", - "type": "object" - } - ] - } - ] - }, - "description": { - "type": "string" - } - }, - "title": "Serve Error Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / $refAdded value: +"#/$defs/rulesets_ServeErrorStatusCode" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / descriptionRemoved value: -"The status code to use for the error." - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / maximumRemoved value: -999 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / minimumRemoved value: -400 - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / titleRemoved value: -"Status Code" - removed
Input schema / properties / payload / $defs / rulesets_ServeErrorStatusCode / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / $refAdded value: +"#/$defs/rulesets_SetCacheControlCloudflareOnly" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / descriptionRemoved value: -"Whether the directive should only be applied to the Cloudflare CDN cache." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / titleRemoved value: -"Cloudflare Only" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlCloudflareOnly / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / $refAdded value: +"#/$defs/rulesets_SetCacheControlDirective" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / descriptionRemoved value: -"A cache-control directive configuration." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / oneOfRemoved value: -[ - { - "description": "Set the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirective / titleRemoved value: -"Cache Control Directive" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / $refAdded value: +"#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / descriptionRemoved value: -"A cache-control directive configuration that accepts optional qualifiers (header names)." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / oneOfRemoved value: -[ - { - "description": "Set the directive with optional qualifiers.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "qualifiers": { - "description": "Optional list of header names to qualify the directive (e.g., for \"private\" or \"no-cache\" directives).", - "items": { - "description": "A header name to qualify the directive.", - "minLength": 1, - "title": "Qualifier", - "type": "string" - }, - "title": "Qualifiers", - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "operation" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithQualifiers / titleRemoved value: -"Cache Control Directive With Optional Qualifiers" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / $refAdded value: +"#/$defs/rulesets_SetCacheControlDirectiveWithValue" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / descriptionRemoved value: -"A cache-control directive configuration that accepts a duration value in seconds." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / oneOfRemoved value: -[ - { - "description": "Set the directive with a duration value in seconds.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "value": { - "description": "The duration value in seconds for the directive.", - "minimum": 0, - "title": "Value", - "type": "integer" - } - }, - "required": [ - "operation", - "value" - ], - "title": "Set Directive", - "type": "object" - }, - { - "description": "Remove the directive.", - "properties": { - "cloudflare_only": { - "$ref": "#/$defs/rulesets_SetCacheControlCloudflareOnly" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheControlOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation" - ], - "title": "Remove Directive", - "type": "object" - } -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlDirectiveWithValue / titleRemoved value: -"Cache Control Directive With Duration Seconds Value" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / $refAdded value: +"#/$defs/rulesets_SetCacheControlOperation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / descriptionRemoved value: -"The operation to perform on the cache-control directive." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / enumRemoved value: -[ - "set", - "remove" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / titleRemoved value: -"Operation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlOperation / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SetCacheControlRule / $refAdded value: +"#/$defs/rulesets_SetCacheControlRule" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheControlRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_cache_control" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "immutable": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "max-age": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - }, - "must-revalidate": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "must-understand": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "no-cache": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers" - }, - "no-store": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "no-transform": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "private": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithQualifiers" - }, - "proxy-revalidate": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "public": { - "$ref": "#/$defs/rulesets_SetCacheControlDirective" - }, - "s-maxage": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - }, - "stale-if-error": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - }, - "stale-while-revalidate": { - "$ref": "#/$defs/rulesets_SetCacheControlDirectiveWithValue" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Set Cache Control Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsAdditionalCacheablePorts" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / descriptionRemoved value: -"A list of additional ports that caching should be enabled on." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / itemsRemoved value: -{ - "description": "A port to enable caching on.", - "maximum": 65535, - "minimum": 1, - "title": "Additional Cacheable Port", - "type": "integer" -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / titleRemoved value: -"Additional Cacheable Ports (Enterprise-Only)" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsAdditionalCacheablePorts / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsBrowserTTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / descriptionRemoved value: -"How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / propertiesRemoved value: -{ - "default": { - "description": "The browser TTL (in seconds) if you choose the \"override_origin\" mode.", - "minimum": 0, - "title": "Default TTL", - "type": "integer" - }, - "mode": { - "description": "The browser TTL mode.", - "enum": [ - "respect_origin", - "bypass_by_default", - "override_origin", - "bypass" - ], - "title": "TTL Mode", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / requiredRemoved value: -[ - "mode" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / titleRemoved value: -"Browser TTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsBrowserTTL / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCache" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / descriptionRemoved value: -"Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / titleRemoved value: -"Cache" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCache / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCacheKey" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / descriptionRemoved value: -"Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / propertiesRemoved value: -{ - "cache_by_device_type": { - "description": "Whether to separate cached content based on the visitor's device type.", - "title": "Cache by Device Type", - "type": "boolean" - }, - "cache_deception_armor": { - "description": "Whether to protect from web cache deception attacks, while allowing static assets to be cached.", - "title": "Cache Deception Armor", - "type": "boolean" - }, - "custom_key": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKey" - }, - "ignore_query_strings_order": { - "description": "Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.", - "title": "Ignore Query Strings Order", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / titleRemoved value: -"Cache Key" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheKey / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCacheReserve" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / descriptionRemoved value: -"Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan)." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / propertiesRemoved value: -{ - "eligible": { - "description": "Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.", - "title": "Eligible", - "type": "boolean" - }, - "minimum_file_size": { - "description": "The minimum file size eligible for storage in Cache Reserve.", - "minimum": 0, - "title": "Minimum File Size", - "type": "integer" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / requiredRemoved value: -[ - "eligible" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / titleRemoved value: -"Cache Reserve" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCacheReserve / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKey" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / descriptionRemoved value: -"Which components of the request are included or excluded from the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / propertiesRemoved value: -{ - "cookie": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyCookie" - }, - "header": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHeader" - }, - "host": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHost" - }, - "query_string": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyQueryString" - }, - "user": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCustomCacheKeyUser" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / titleRemoved value: -"Custom Cache Key" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKey / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyCookie" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / descriptionRemoved value: -"Which cookies to include in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / propertiesRemoved value: -{ - "check_presence": { - "description": "A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.", - "items": { - "description": "The name of the cookie to check for the presence of.", - "minLength": 1, - "title": "Cookie Name", - "type": "string" - }, - "minItems": 1, - "title": "Check Presence", - "type": "array", - "uniqueItems": true - }, - "include": { - "description": "A list of cookies to include in the cache key.", - "items": { - "description": "The name of the cookie to include.", - "minLength": 1, - "title": "Cookie Name", - "type": "string" - }, - "minItems": 1, - "title": "Include", - "type": "array", - "uniqueItems": true - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / titleRemoved value: -"Cookies" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyCookie / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHeader" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / descriptionRemoved value: -"Which headers to include in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / propertiesRemoved value: -{ - "check_presence": { - "description": "A list of headers to check for the presence of. The presence of these headers is included in the cache key.", - "items": { - "description": "The name of the header to check for the presence of.", - "minLength": 1, - "title": "Header", - "type": "string" - }, - "minItems": 1, - "title": "Check Presence", - "type": "array", - "uniqueItems": true - }, - "contains": { - "additionalProperties": { - "description": "A list of values to match the header against.", - "items": { - "description": "The header value to match against.", - "minLength": 1, - "title": "Header Value", - "type": "string" - }, - "minItems": 1, - "title": "Header Values", - "type": "array", - "uniqueItems": true - }, - "description": "A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.", - "minProperties": 1, - "title": "Contains", - "type": "object" - }, - "exclude_origin": { - "description": "Whether to exclude the origin header in the cache key.", - "title": "Exclude Origin", - "type": "boolean" - }, - "include": { - "description": "A list of headers to include in the cache key.", - "items": { - "description": "The name of the header to include.", - "minLength": 1, - "title": "Header", - "type": "string" - }, - "minItems": 1, - "title": "Include", - "type": "array", - "uniqueItems": true - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / titleRemoved value: -"Headers" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHeader / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyHost" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / descriptionRemoved value: -"How to use the host in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / propertiesRemoved value: -{ - "resolved": { - "description": "Whether to use the resolved host in the cache key.", - "title": "Use Resolved Host", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / titleRemoved value: -"Host" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyHost / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyQueryString" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / descriptionRemoved value: -"Which query string parameters to include in or exclude from the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / maxPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / propertiesRemoved value: -{ - "exclude": { - "description": "Which query string parameters to exclude from the cache key.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "all": { - "description": "Whether to exclude all query string parameters from the cache key.", - "enum": [ - true - ], - "title": "Exclude All", - "type": "boolean" - }, - "list": { - "description": "A list of query string parameters to exclude from the cache key.", - "items": { - "description": "The name of the query string parameter to exclude.", - "minLength": 1, - "title": "Parameter Name", - "type": "string" - }, - "minItems": 1, - "title": "Exclude List", - "type": "array", - "uniqueItems": true - } - }, - "title": "Exclude", - "type": "object" - }, - "include": { - "description": "Which query string parameters to include in the cache key.", - "maxProperties": 1, - "minProperties": 1, - "properties": { - "all": { - "description": "Whether to include all query string parameters in the cache key.", - "enum": [ - true - ], - "title": "Include All", - "type": "boolean" - }, - "list": { - "description": "A list of query string parameters to include in the cache key.", - "items": { - "description": "The name of the query string parameter to include.", - "minLength": 1, - "title": "Parameter Name", - "type": "string" - }, - "minItems": 1, - "title": "Include List", - "type": "array", - "uniqueItems": true - } - }, - "title": "Include", - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / titleRemoved value: -"Query String Parameters" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyQueryString / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsCustomCacheKeyUser" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / descriptionRemoved value: -"How to use characteristics of the request user agent in the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / propertiesRemoved value: -{ - "device_type": { - "description": "Whether to use the user agent's device type in the cache key.", - "title": "Device Type", - "type": "boolean" - }, - "geo": { - "description": "Whether to use the user agents's country in the cache key.", - "title": "Country", - "type": "boolean" - }, - "lang": { - "description": "Whether to use the user agent's language in the cache key.", - "title": "Language", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / titleRemoved value: -"User" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsCustomCacheKeyUser / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsEdgeTTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / descriptionRemoved value: -"How long the Cloudflare edge network should cache the response." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / propertiesRemoved value: -{ - "default": { - "description": "The edge TTL (in seconds) if you choose the \"override_origin\" mode.", - "minimum": 0, - "title": "Default TTL", - "type": "integer" - }, - "mode": { - "description": "The edge TTL mode.", - "enum": [ - "respect_origin", - "bypass_by_default", - "override_origin" - ], - "title": "TTL Mode", - "type": "string" - }, - "status_code_ttl": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStatusCodeTTL" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / requiredRemoved value: -[ - "mode" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / titleRemoved value: -"Edge TTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsEdgeTTL / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsOriginCacheControl" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / descriptionRemoved value: -"Whether Cloudflare will aim to strictly adhere to RFC 7234." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / titleRemoved value: -"Origin Cache Control (Enterprise-Only)" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginCacheControl / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsOriginErrorPagePassthru" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / descriptionRemoved value: -"Whether to generate Cloudflare error pages for issues from the origin server." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / titleRemoved value: -"Origin Error Page Passthrough" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginErrorPagePassthru / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsOriginRangeRequests" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / descriptionRemoved value: -"Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / propertiesRemoved value: -{ - "mode": { - "description": "Whether to use range requests. `default` is the behaviour the zone gets without this rule.", - "enum": [ - "on", - "off", - "default" - ], - "title": "Mode", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / requiredRemoved value: -[ - "mode" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / titleRemoved value: -"Origin Range Requests" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsOriginRangeRequests / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsReadTimeout" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / descriptionRemoved value: -"A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / maximumRemoved value: -6000 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / minimumRemoved value: -100 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / titleRemoved value: -"Read Timeout (Enterprise-Only)" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsReadTimeout / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsRespectStrongEtags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / descriptionRemoved value: -"Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / titleRemoved value: -"Respect Strong ETags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRespectStrongEtags / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRule / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsRule" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_cache_settings" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "additional_cacheable_ports": { - "$ref": "#/$defs/rulesets_SetCacheSettingsAdditionalCacheablePorts" - }, - "browser_ttl": { - "$ref": "#/$defs/rulesets_SetCacheSettingsBrowserTTL" - }, - "cache": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCache" - }, - "cache_key": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCacheKey" - }, - "cache_reserve": { - "$ref": "#/$defs/rulesets_SetCacheSettingsCacheReserve" - }, - "edge_ttl": { - "$ref": "#/$defs/rulesets_SetCacheSettingsEdgeTTL" - }, - "origin_cache_control": { - "$ref": "#/$defs/rulesets_SetCacheSettingsOriginCacheControl" - }, - "origin_error_page_passthru": { - "$ref": "#/$defs/rulesets_SetCacheSettingsOriginErrorPagePassthru" - }, - "origin_range_requests": { - "$ref": "#/$defs/rulesets_SetCacheSettingsOriginRangeRequests" - }, - "read_timeout": { - "$ref": "#/$defs/rulesets_SetCacheSettingsReadTimeout" - }, - "respect_strong_etags": { - "$ref": "#/$defs/rulesets_SetCacheSettingsRespectStrongEtags" - }, - "serve_stale": { - "$ref": "#/$defs/rulesets_SetCacheSettingsServeStale" - }, - "shared_dictionary": { - "$ref": "#/$defs/rulesets_SetCacheSettingsSharedDictionary" - }, - "strip_etags": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStripETags" - }, - "strip_last_modified": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStripLastModified" - }, - "strip_set_cookie": { - "$ref": "#/$defs/rulesets_SetCacheSettingsStripSetCookie" - }, - "vary": { - "$ref": "#/$defs/rulesets_SetCacheSettingsVary" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Set Cache Settings Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsServeStale" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / descriptionRemoved value: -"When to serve stale content from cache." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / propertiesRemoved value: -{ - "disable_stale_while_updating": { - "description": "Whether Cloudflare should disable serving stale content while getting the latest content from the origin.", - "title": "Disable Stale While Updating", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / titleRemoved value: -"Serve Stale" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsServeStale / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsSharedDictionary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / descriptionRemoved value: -"Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / propertiesRemoved value: -{ - "match_pattern": { - "description": "URL pattern for the Use-As-Dictionary match field. This pattern specifies which URLs can use this response as a dictionary.", - "maxLength": 1024, - "minLength": 1, - "title": "Match Pattern", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / requiredRemoved value: -[ - "match_pattern" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / titleRemoved value: -"Shared Dictionary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsSharedDictionary / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStatusCodeTTL" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / descriptionRemoved value: -"A list of TTLs to apply to specific status codes or status code ranges." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / itemsRemoved value: -{ - "maxProperties": 2, - "minProperties": 2, - "properties": { - "status_code": { - "description": "A single status code to apply the TTL to.", - "maximum": 999, - "minimum": 100, - "title": "Status Code", - "type": "integer" - }, - "status_code_range": { - "description": "A range of status codes to apply the TTL to.", - "minProperties": 1, - "properties": { - "from": { - "description": "The lower bound of the range.", - "maximum": 999, - "minimum": 100, - "title": "From", - "type": "integer" - }, - "to": { - "description": "The upper bound of the range.", - "maximum": 999, - "minimum": 100, - "title": "To", - "type": "integer" - } - }, - "title": "Status Code Range", - "type": "object" - }, - "value": { - "description": "The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value \"no-cache\". A value of -1 is equivalent to setting the cache control header with the value of \"no-store\".", - "title": "TTL Value", - "type": "integer" - } - }, - "required": [ - "value" - ], - "type": "object" -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / titleRemoved value: -"Status Code TTLs" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStatusCodeTTL / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStripETags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / descriptionRemoved value: -"Whether to strip ETag headers from the origin response before caching." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / titleRemoved value: -"Strip ETags" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripETags / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStripLastModified" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / descriptionRemoved value: -"Whether to strip Last-Modified headers from the origin response before caching." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / titleRemoved value: -"Strip Last-Modified" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripLastModified / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsStripSetCookie" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / descriptionRemoved value: -"Whether to strip Set-Cookie headers from the origin response before caching." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / titleRemoved value: -"Strip Set-Cookie" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsStripSetCookie / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsVary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / descriptionRemoved value: -"Controls how cached responses vary based on request headers. `default` is required by the API and applies to any Vary response header that does not have a per-header override." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / propertiesRemoved value: -{ - "default": { - "$ref": "#/$defs/rulesets_SetCacheSettingsVaryDefault" - }, - "headers": { - "additionalProperties": { - "$ref": "#/$defs/rulesets_SetCacheSettingsVaryHeader" - }, - "description": "A mapping of lowercase request header names to their vary configuration.", - "maxProperties": 50, - "title": "Headers", - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / titleRemoved value: -"Vary" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVary / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsVaryDefault" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / descriptionRemoved value: -"Controls how response Vary headers without a per-header override contribute to the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / propertiesRemoved value: -{ - "action": { - "description": "How the header value is treated when building the cache key.", - "enum": [ - "bypass", - "passthrough", - "normalize" - ], - "title": "Action", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / requiredRemoved value: -[ - "action" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / titleRemoved value: -"Vary Default" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryDefault / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / $refAdded value: +"#/$defs/rulesets_SetCacheSettingsVaryHeader" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / descriptionRemoved value: -"Controls how a single request header contributes to the cache key." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / propertiesRemoved value: -{ - "action": { - "description": "How the header value is treated when building the cache key.", - "enum": [ - "bypass", - "passthrough", - "normalize" - ], - "title": "Action", - "type": "string" - }, - "languages": { - "description": "The set of languages to normalize against. Only valid for the `accept-language` header.", - "items": { - "description": "A language tag to normalize against. Must be printable ASCII.", - "maxLength": 64, - "minLength": 1, - "pattern": "^[ -~]+$", - "title": "Language", - "type": "string" - }, - "maxItems": 20, - "title": "Languages", - "type": "array" - }, - "media_types": { - "description": "The set of media types to normalize against. Only valid for the `accept` header.", - "items": { - "description": "A media type to normalize against. Must be printable ASCII.", - "maxLength": 255, - "minLength": 1, - "pattern": "^[ -~]+$", - "title": "Media Type", - "type": "string" - }, - "maxItems": 10, - "title": "Media Types", - "type": "array" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / requiredRemoved value: -[ - "action" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / titleRemoved value: -"Vary Header" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheSettingsVaryHeader / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / $refAdded value: +"#/$defs/rulesets_SetCacheTagsExpression" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / descriptionRemoved value: -"An expression that evaluates to an array of cache tag values." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / minLengthRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / titleRemoved value: -"Expression" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsExpression / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / $refAdded value: +"#/$defs/rulesets_SetCacheTagsOperation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / descriptionRemoved value: -"The operation to perform on the cache tags." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / enumRemoved value: -[ - "add", - "remove", - "set" -] - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / titleRemoved value: -"Operation" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsOperation / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsRule / $refAdded value: +"#/$defs/rulesets_SetCacheTagsRule" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_cache_tags" - ], - "type": "string" - }, - "action_parameters": { - "oneOf": [ - { - "description": "Add cache tags using a list of values.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - }, - "values": { - "$ref": "#/$defs/rulesets_SetCacheTagsValues" - } - }, - "required": [ - "operation", - "values" - ], - "title": "Add Cache Tags (Values)", - "type": "object" - }, - { - "description": "Add cache tags using an expression.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_SetCacheTagsExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "add" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Add Cache Tags (Expression)", - "type": "object" - }, - { - "description": "Remove cache tags using a list of values.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - }, - "values": { - "$ref": "#/$defs/rulesets_SetCacheTagsValues" - } - }, - "required": [ - "operation", - "values" - ], - "title": "Remove Cache Tags (Values)", - "type": "object" - }, - { - "description": "Remove cache tags using an expression.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_SetCacheTagsExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "remove" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Remove Cache Tags (Expression)", - "type": "object" - }, - { - "description": "Set cache tags using a list of values.", - "properties": { - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - }, - "values": { - "$ref": "#/$defs/rulesets_SetCacheTagsValues" - } - }, - "required": [ - "operation", - "values" - ], - "title": "Set Cache Tags (Values)", - "type": "object" - }, - { - "description": "Set cache tags using an expression.", - "properties": { - "expression": { - "$ref": "#/$defs/rulesets_SetCacheTagsExpression" - }, - "operation": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_SetCacheTagsOperation" - }, - { - "enum": [ - "set" - ], - "type": "string" - } - ] - } - }, - "required": [ - "operation", - "expression" - ], - "title": "Set Cache Tags (Expression)", - "type": "object" - } - ] - }, - "description": { - "type": "string" - } - }, - "title": "Set Cache Tags Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / $refAdded value: +"#/$defs/rulesets_SetCacheTagsValues" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / descriptionRemoved value: -"A list of cache tag values." - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / itemsRemoved value: -{ - "description": "A cache tag value.", - "minLength": 1, - "title": "Cache Tag", - "type": "string" -} - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / maxItemsRemoved value: -100 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / titleRemoved value: -"Values" - removed
Input schema / properties / payload / $defs / rulesets_SetCacheTagsValues / typeRemoved value: -"array" - added
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / $refAdded value: +"#/$defs/rulesets_SetConfigAutominify" - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / descriptionRemoved value: -"Which file extensions to minify automatically." - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / propertiesRemoved value: -{ - "css": { - "default": false, - "description": "Whether to minify CSS files.", - "title": "CSS", - "type": "boolean" - }, - "html": { - "default": false, - "description": "Whether to minify HTML files.", - "title": "HTML", - "type": "boolean" - }, - "js": { - "default": false, - "description": "Whether to minify JavaScript files.", - "title": "JavaScript", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / titleRemoved value: -"Auto-Minify" - removed
Input schema / properties / payload / $defs / rulesets_SetConfigAutominify / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SetConfigRule / $refAdded value: +"#/$defs/rulesets_SetConfigRule" - removed
Input schema / properties / payload / $defs / rulesets_SetConfigRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "set_config" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "automatic_https_rewrites": { - "description": "Whether to enable Automatic HTTPS Rewrites.", - "title": "Automatic HTTPS Rewrites", - "type": "boolean" - }, - "autominify": { - "$ref": "#/$defs/rulesets_SetConfigAutominify" - }, - "bic": { - "description": "Whether to enable Browser Integrity Check (BIC).", - "title": "Browser Integrity Check", - "type": "boolean" - }, - "content_converter": { - "description": "Whether to enable content conversion (e.g., HTML to Markdown).", - "title": "Content Converter", - "type": "boolean" - }, - "disable_apps": { - "deprecated": true, - "description": "Whether to disable Cloudflare Apps.", - "enum": [ - true - ], - "title": "Disable Apps", - "type": "boolean" - }, - "disable_pay_per_crawl": { - "description": "Whether to disable Pay Per Crawl.", - "enum": [ - true - ], - "title": "Disable Pay Per Crawl", - "type": "boolean" - }, - "disable_rum": { - "description": "Whether to disable Real User Monitoring (RUM).", - "enum": [ - true - ], - "title": "Disable RUM", - "type": "boolean" - }, - "disable_zaraz": { - "description": "Whether to disable Zaraz.", - "enum": [ - true - ], - "title": "Disable Zaraz", - "type": "boolean" - }, - "email_obfuscation": { - "description": "Whether to enable Email Obfuscation.", - "title": "Email Obfuscation", - "type": "boolean" - }, - "fonts": { - "description": "Whether to enable Cloudflare Fonts.", - "title": "Cloudflare Fonts", - "type": "boolean" - }, - "hotlink_protection": { - "description": "Whether to enable Hotlink Protection.", - "title": "Hotlink Protection", - "type": "boolean" - }, - "mirage": { - "deprecated": true, - "description": "Whether to enable Mirage.", - "title": "Mirage", - "type": "boolean" - }, - "opportunistic_encryption": { - "description": "Whether to enable Opportunistic Encryption.", - "title": "Opportunistic Encryption", - "type": "boolean" - }, - "polish": { - "description": "The Polish level to configure.", - "enum": [ - "off", - "lossless", - "lossy", - "webp" - ], - "title": "Polish", - "type": "string" - }, - "redirects_for_ai_training": { - "description": "Whether to redirect verified AI training crawlers to canonical URLs found in the HTML response.", - "title": "Redirects for AI Training", - "type": "boolean" - }, - "request_body_buffering": { - "description": "The request body buffering mode.", - "enum": [ - "none", - "standard", - "full" - ], - "title": "Request body buffering", - "type": "string" - }, - "response_body_buffering": { - "description": "The response body buffering mode.", - "enum": [ - "none", - "standard" - ], - "title": "Response body buffering", - "type": "string" - }, - "rocket_loader": { - "description": "Whether to enable Rocket Loader.", - "title": "Rocket Loader", - "type": "boolean" - }, - "security_level": { - "description": "The Security Level to configure.", - "enum": [ - "off", - "essentially_off", - "low", - "medium", - "high", - "under_attack" - ], - "title": "Security Level", - "type": "string" - }, - "server_side_excludes": { - "description": "Whether to enable Server-Side Excludes.", - "title": "Server-Side Excludes", - "type": "boolean" - }, - "ssl": { - "description": "The SSL level to configure.", - "enum": [ - "off", - "flexible", - "full", - "strict", - "origin_pull" - ], - "title": "SSL", - "type": "string" - }, - "sxg": { - "deprecated": true, - "description": "Whether to enable Signed Exchanges (SXG).", - "title": "Signed Exchanges", - "type": "boolean" - }, - "webmcp_enabled": { - "description": "Whether to serve the WebMCP bridge script, which exposes the page's tools to browser AI agents.", - "title": "WebMCP", - "type": "boolean" - }, - "webmcp_packs": { - "description": "Bundled WebMCP tool packs to activate for matching requests. An empty array disables all packs. Omitting this parameter leaves the pack selection unchanged. Does not enable the WebMCP bridge itself. Non-empty selections require the WebMCP Configuration Rules entitlement.", - "items": { - "description": "A tool-pack identifier understood by the WebMCP interceptor.", - "maxLength": 128, - "minLength": 1, - "pattern": "^[A-Za-z0-9._:/@-]+$", - "type": "string" - }, - "maxItems": 100, - "title": "WebMCP Tool Packs", - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Set Configuration Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SkipPhase / $refAdded value: +"#/$defs/rulesets_SkipPhase" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / descriptionRemoved value: -"A phase to skip the execution of. This option is only compatible with the products option." - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / enumRemoved value: -[ - "current" -] - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / titleRemoved value: -"Phase" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhase / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SkipPhases / $refAdded value: +"#/$defs/rulesets_SkipPhases" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / descriptionRemoved value: -"A list of phases to skip the execution of. This option is incompatible with the rulesets option." - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / itemsRemoved value: -{ - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetPhase" - }, - { - "description": "The phase to skip the execution of.", - "type": "string" - } - ] -} - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / titleRemoved value: -"Phases" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SkipPhases / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SkipProducts / $refAdded value: +"#/$defs/rulesets_SkipProducts" - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / descriptionRemoved value: -"A list of legacy security products to skip the execution of." - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / itemsRemoved value: -{ - "description": "The name of a legacy security product to skip the execution of.", - "enum": [ - "bic", - "hot", - "rateLimit", - "securityLevel", - "uaBlock", - "waf", - "zoneLockdown" - ], - "title": "Product", - "type": "string" -} - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / titleRemoved value: -"Products" - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SkipProducts / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_SkipRule / $refAdded value: +"#/$defs/rulesets_SkipRule" - removed
Input schema / properties / payload / $defs / rulesets_SkipRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "skip" - ], - "type": "string" - }, - "action_parameters": { - "minProperties": 1, - "properties": { - "phase": { - "$ref": "#/$defs/rulesets_SkipPhase" - }, - "phases": { - "$ref": "#/$defs/rulesets_SkipPhases" - }, - "products": { - "$ref": "#/$defs/rulesets_SkipProducts" - }, - "rules": { - "$ref": "#/$defs/rulesets_SkipRules" - }, - "ruleset": { - "$ref": "#/$defs/rulesets_SkipRuleset" - }, - "rulesets": { - "$ref": "#/$defs/rulesets_SkipRulesets" - } - }, - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Skip Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_SkipRules / $refAdded value: +"#/$defs/rulesets_SkipRules" - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / additionalPropertiesRemoved value: -{ - "description": "A list of rule IDs in the ruleset to skip the execution of.", - "items": { - "allOf": [ - { - "$ref": "#/$defs/rulesets_RuleId" - }, - { - "description": "The ID of a rule in the ruleset to skip the execution of.", - "title": "Rule", - "type": "string" - } - ] - }, - "minItems": 1, - "title": "Rules", - "type": "array", - "uniqueItems": true -} - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / descriptionRemoved value: -"A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option." - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / minPropertiesRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / titleRemoved value: -"Rules" - removed
Input schema / properties / payload / $defs / rulesets_SkipRules / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / rulesets_SkipRuleset / $refAdded value: +"#/$defs/rulesets_SkipRuleset" - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / descriptionRemoved value: -"A ruleset to skip the execution of. This option is incompatible with the rulesets option." - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / enumRemoved value: -[ - "current" -] - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / titleRemoved value: -"Ruleset" - removed
Input schema / properties / payload / $defs / rulesets_SkipRuleset / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / rulesets_SkipRulesets / $refAdded value: +"#/$defs/rulesets_SkipRulesets" - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / descriptionRemoved value: -"A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options." - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / itemsRemoved value: -{ - "allOf": [ - { - "$ref": "#/$defs/rulesets_RulesetId" - }, - { - "description": "The ID of a ruleset to skip the execution of.", - "title": "Ruleset", - "type": "string" - } - ] -} - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / minItemsRemoved value: -1 - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / titleRemoved value: -"Rulesets" - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / rulesets_SkipRulesets / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / rulesets_TransformResponseHTMLRule / $refAdded value: +"#/$defs/rulesets_TransformResponseHTMLRule" - removed
Input schema / properties / payload / $defs / rulesets_TransformResponseHTMLRule / allOfRemoved value: -[ - { - "$ref": "#/$defs/rulesets_Rule" - }, - { - "properties": { - "action": { - "enum": [ - "transform_response_html" - ], - "type": "string" - }, - "action_parameters": { - "properties": { - "link_maze": { - "description": "Enables the link maze transformation on the response.", - "title": "Link Maze", - "type": "object" - } - }, - "required": [ - "link_maze" - ], - "type": "object" - }, - "description": { - "type": "string" - } - }, - "title": "Transform Response HTML Rule", - "type": "object" - } -] - added
Input schema / properties / payload / $defs / rulesets_ZoneId / $refAdded value: +"#/$defs/rulesets_ZoneId" - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / descriptionRemoved value: -"The unique ID of the zone." - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / patternRemoved value: -"^[0-9a-f]{32}$" - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / titleRemoved value: -"Zone ID" - removed
Input schema / properties / payload / $defs / rulesets_ZoneId / typeRemoved value: -"string"
- Changed
update_zone_setting466 fields changed- added
Input schema / $defs / zones_browser_check_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / $defs / zones_browser_check_value / defaultRemoved value: -"on" - removed
Input schema / $defs / zones_browser_check_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_browser_check_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_browser_check_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_china_network_enabled_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_china_network_enabled_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_china_network_enabled_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_china_network_enabled_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_china_network_enabled_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_content_converter_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_content_converter_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_content_converter_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_content_converter_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_content_converter_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_development_mode_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_development_mode_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_development_mode_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_development_mode_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_development_mode_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_early_hints_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_early_hints_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_early_hints_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_early_hints_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_early_hints_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_email_obfuscation_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / $defs / zones_email_obfuscation_value / defaultRemoved value: -"on" - removed
Input schema / $defs / zones_email_obfuscation_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_email_obfuscation_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_email_obfuscation_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_hotlink_protection_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_hotlink_protection_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_hotlink_protection_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_hotlink_protection_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_hotlink_protection_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_ip_geolocation_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / $defs / zones_ip_geolocation_value / defaultRemoved value: -"on" - removed
Input schema / $defs / zones_ip_geolocation_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_ip_geolocation_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_ip_geolocation_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_ipv6_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_ipv6_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_ipv6_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_ipv6_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_ipv6_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_opportunistic_encryption_value / $refAdded value: +"#/$defs/zones_automatic_https_rewrites_value" - removed
Input schema / $defs / zones_opportunistic_encryption_value / defaultRemoved value: -"on" - removed
Input schema / $defs / zones_opportunistic_encryption_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Default value depends on the zone's plan level." - removed
Input schema / $defs / zones_opportunistic_encryption_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_opportunistic_encryption_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_origin_error_page_pass_thru_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_origin_error_page_pass_thru_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_origin_error_page_pass_thru_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_origin_error_page_pass_thru_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_origin_error_page_pass_thru_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_pre_render_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_pre_render_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_pre_render_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_pre_render_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_pre_render_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_prefetch_preload_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_prefetch_preload_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_prefetch_preload_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_prefetch_preload_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_prefetch_preload_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_redirects_for_ai_training_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_redirects_for_ai_training_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_redirects_for_ai_training_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_redirects_for_ai_training_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_redirects_for_ai_training_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_replace_insecure_js_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_replace_insecure_js_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_replace_insecure_js_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_replace_insecure_js_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_replace_insecure_js_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_response_buffering_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_response_buffering_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_response_buffering_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_response_buffering_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_response_buffering_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_rocket_loader_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_rocket_loader_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_rocket_loader_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_rocket_loader_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_rocket_loader_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_search_for_agents_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_search_for_agents_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_search_for_agents_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_search_for_agents_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_search_for_agents_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_server_side_exclude_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / $defs / zones_server_side_exclude_value / defaultRemoved value: -"on" - removed
Input schema / $defs / zones_server_side_exclude_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_server_side_exclude_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_server_side_exclude_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_sha1_support_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_sha1_support_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_sha1_support_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_sha1_support_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_sha1_support_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_sort_query_string_for_cache_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_sort_query_string_for_cache_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_sort_query_string_for_cache_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_sort_query_string_for_cache_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_sort_query_string_for_cache_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_tls_1_2_only_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_tls_1_2_only_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_tls_1_2_only_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_tls_1_2_only_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_tls_1_2_only_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_true_client_ip_header_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_true_client_ip_header_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_true_client_ip_header_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_true_client_ip_header_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_true_client_ip_header_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_waf_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / $defs / zones_waf_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_waf_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_waf_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / $defs / zones_waf_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_webmcp_enabled_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_webmcp_enabled_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_webmcp_enabled_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_webmcp_enabled_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_webmcp_enabled_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_webp_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_webp_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_webp_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_webp_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_webp_value / typeRemoved value: -"string" - added
Input schema / $defs / zones_websockets_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / $defs / zones_websockets_value / defaultRemoved value: -"off" - removed
Input schema / $defs / zones_websockets_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / $defs / zones_websockets_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / $defs / zones_websockets_value / typeRemoved value: -"string" - changed
Input schema / properties / confirm / descriptionPrevious value: -"Must be true for the exact selected mutation, target and reviewed request."New value: +"Set true only when the user asked for exactly this action." - added
Input schema / properties / payload / $defs / zones_0rtt_value / $refAdded value: +"#/$defs/zones_0rtt_value" - removed
Input schema / properties / payload / $defs / zones_0rtt_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_0rtt_value / descriptionRemoved value: -"Value of the 0-RTT setting." - removed
Input schema / properties / payload / $defs / zones_0rtt_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_0rtt_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_advanced_ddos_value / $refAdded value: +"#/$defs/zones_advanced_ddos_value" - removed
Input schema / properties / payload / $defs / zones_advanced_ddos_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_advanced_ddos_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Defaults to on for Business+ plans" - removed
Input schema / properties / payload / $defs / zones_advanced_ddos_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_advanced_ddos_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_always_online_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / properties / payload / $defs / zones_always_online_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_always_online_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_always_online_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_always_online_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_always_use_https_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_always_use_https_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_always_use_https_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_always_use_https_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_always_use_https_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_automatic_https_rewrites_value / $refAdded value: +"#/$defs/zones_automatic_https_rewrites_value" - removed
Input schema / properties / payload / $defs / zones_automatic_https_rewrites_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_automatic_https_rewrites_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Default value depends on the zone's plan level." - removed
Input schema / properties / payload / $defs / zones_automatic_https_rewrites_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_automatic_https_rewrites_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_automatic_platform_optimization / $refAdded value: +"#/$defs/zones_automatic_platform_optimization" - removed
Input schema / properties / payload / $defs / zones_automatic_platform_optimization / propertiesRemoved value: -{ - "cache_by_device_type": { - "description": "Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.", - "type": "boolean" - }, - "cf": { - "default": false, - "description": "Indicates whether or not Cloudflare proxy is enabled.", - "type": "boolean" - }, - "enabled": { - "default": false, - "description": "Indicates whether or not Automatic Platform Optimization is enabled.", - "type": "boolean" - }, - "hostnames": { - "description": "An array of hostnames where Automatic Platform Optimization for WordPress is activated.", - "items": { - "format": "hostname", - "type": "string" - }, - "type": "array" - }, - "wordpress": { - "default": false, - "description": "Indicates whether or not site is powered by WordPress.", - "type": "boolean" - }, - "wp_plugin": { - "default": false, - "description": "Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.", - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / zones_automatic_platform_optimization / requiredRemoved value: -[ - "enabled", - "cf", - "wordpress", - "wp_plugin", - "hostnames", - "cache_by_device_type" -] - removed
Input schema / properties / payload / $defs / zones_automatic_platform_optimization / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / zones_brotli_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_brotli_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_brotli_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_brotli_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_brotli_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_browser_cache_ttl_value / $refAdded value: +"#/$defs/zones_browser_cache_ttl_value" - removed
Input schema / properties / payload / $defs / zones_browser_cache_ttl_value / defaultRemoved value: -14400 - removed
Input schema / properties / payload / $defs / zones_browser_cache_ttl_value / descriptionRemoved value: -"Value of the zone setting in seconds.\nMinimum values by plan:\n- Free: 1 second\n- Pro: 1 second\n- Business: 1 second\n- Enterprise: 1 second\nSetting a TTL of 0 is equivalent to selecting `Respect Existing Headers` and is allowed for all plans." - removed
Input schema / properties / payload / $defs / zones_browser_cache_ttl_value / maximumRemoved value: -31536000 - removed
Input schema / properties / payload / $defs / zones_browser_cache_ttl_value / minimumRemoved value: -0 - removed
Input schema / properties / payload / $defs / zones_browser_cache_ttl_value / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / zones_browser_check_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / properties / payload / $defs / zones_browser_check_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_browser_check_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_browser_check_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_browser_check_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_cache-rules_aegis_value / $refAdded value: +"#/$defs/zones_cache-rules_aegis_value" - removed
Input schema / properties / payload / $defs / zones_cache-rules_aegis_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_cache-rules_aegis_value / propertiesRemoved value: -{ - "enabled": { - "description": "Whether the feature is enabled or not.", - "type": "boolean" - }, - "pool_id": { - "description": "Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin.", - "type": "string" - } -} - removed
Input schema / properties / payload / $defs / zones_cache-rules_aegis_value / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / zones_cache-rules_origin_h2_max_streams_value / $refAdded value: +"#/$defs/zones_cache-rules_origin_h2_max_streams_value" - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_h2_max_streams_value / descriptionRemoved value: -"Value of the Origin H2 Max Streams Setting." - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_h2_max_streams_value / maximumRemoved value: -1000 - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_h2_max_streams_value / minimumRemoved value: -1 - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_h2_max_streams_value / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / zones_cache-rules_origin_max_http_version_value / $refAdded value: +"#/$defs/zones_cache-rules_origin_max_http_version_value" - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_max_http_version_value / descriptionRemoved value: -"Value of the Origin Max HTTP Version Setting." - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_max_http_version_value / enumRemoved value: -[ - "2", - "1" -] - removed
Input schema / properties / payload / $defs / zones_cache-rules_origin_max_http_version_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_cache_level_value / $refAdded value: +"#/$defs/zones_cache_level_value" - removed
Input schema / properties / payload / $defs / zones_cache_level_value / defaultRemoved value: -"aggressive" - removed
Input schema / properties / payload / $defs / zones_cache_level_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_cache_level_value / enumRemoved value: -[ - "aggressive", - "basic", - "simplified" -] - removed
Input schema / properties / payload / $defs / zones_cache_level_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_challenge_ttl_value / $refAdded value: +"#/$defs/zones_challenge_ttl_value" - removed
Input schema / properties / payload / $defs / zones_challenge_ttl_value / defaultRemoved value: -1800 - removed
Input schema / properties / payload / $defs / zones_challenge_ttl_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_challenge_ttl_value / enumRemoved value: -[ - 300, - 900, - 1800, - 2700, - 3600, - 7200, - 10800, - 14400, - 28800, - 57600, - 86400, - 604800, - 2592000, - 31536000 -] - removed
Input schema / properties / payload / $defs / zones_challenge_ttl_value / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / zones_china_network_enabled_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_china_network_enabled_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_china_network_enabled_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_china_network_enabled_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_china_network_enabled_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_ciphers_value / $refAdded value: +"#/$defs/zones_ciphers_value" - removed
Input schema / properties / payload / $defs / zones_ciphers_value / defaultRemoved value: -[] - removed
Input schema / properties / payload / $defs / zones_ciphers_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_ciphers_value / itemsRemoved value: -{ - "type": "string" -} - removed
Input schema / properties / payload / $defs / zones_ciphers_value / typeRemoved value: -"array" - removed
Input schema / properties / payload / $defs / zones_ciphers_value / uniqueItemsRemoved value: -true - added
Input schema / properties / payload / $defs / zones_cname_flattening_value / $refAdded value: +"#/$defs/zones_cname_flattening_value" - removed
Input schema / properties / payload / $defs / zones_cname_flattening_value / defaultRemoved value: -"flatten_at_root" - removed
Input schema / properties / payload / $defs / zones_cname_flattening_value / deprecatedRemoved value: -true - removed
Input schema / properties / payload / $defs / zones_cname_flattening_value / descriptionRemoved value: -"Value of the cname flattening setting." - removed
Input schema / properties / payload / $defs / zones_cname_flattening_value / enumRemoved value: -[ - "flatten_at_root", - "flatten_all" -] - removed
Input schema / properties / payload / $defs / zones_cname_flattening_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_content_converter_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_content_converter_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_content_converter_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_content_converter_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_content_converter_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_development_mode_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_development_mode_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_development_mode_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_development_mode_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_development_mode_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_early_hints_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_early_hints_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_early_hints_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_early_hints_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_early_hints_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_edge_cache_ttl_value / $refAdded value: +"#/$defs/zones_edge_cache_ttl_value" - removed
Input schema / properties / payload / $defs / zones_edge_cache_ttl_value / defaultRemoved value: -7200 - removed
Input schema / properties / payload / $defs / zones_edge_cache_ttl_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)" - removed
Input schema / properties / payload / $defs / zones_edge_cache_ttl_value / enumRemoved value: -[ - 30, - 60, - 300, - 1200, - 1800, - 3600, - 7200, - 10800, - 14400, - 18000, - 28800, - 43200, - 57600, - 72000, - 86400, - 172800, - 259200, - 345600, - 432000, - 518400, - 604800 -] - removed
Input schema / properties / payload / $defs / zones_edge_cache_ttl_value / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / zones_email_obfuscation_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / properties / payload / $defs / zones_email_obfuscation_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_email_obfuscation_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_email_obfuscation_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_email_obfuscation_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_h2_prioritization_value / $refAdded value: +"#/$defs/zones_h2_prioritization_value" - removed
Input schema / properties / payload / $defs / zones_h2_prioritization_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_h2_prioritization_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_h2_prioritization_value / enumRemoved value: -[ - "on", - "off", - "custom" -] - removed
Input schema / properties / payload / $defs / zones_h2_prioritization_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_hotlink_protection_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_hotlink_protection_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_hotlink_protection_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_hotlink_protection_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_hotlink_protection_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_http2_value / $refAdded value: +"#/$defs/zones_http2_value" - removed
Input schema / properties / payload / $defs / zones_http2_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_http2_value / descriptionRemoved value: -"Value of the HTTP2 setting." - removed
Input schema / properties / payload / $defs / zones_http2_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_http2_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_http3_value / $refAdded value: +"#/$defs/zones_http3_value" - removed
Input schema / properties / payload / $defs / zones_http3_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_http3_value / descriptionRemoved value: -"Value of the HTTP3 setting." - removed
Input schema / properties / payload / $defs / zones_http3_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_http3_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_identifier / $refAdded value: +"#/$defs/zones_identifier" - removed
Input schema / properties / payload / $defs / zones_identifier / descriptionRemoved value: -"Identifier" - removed
Input schema / properties / payload / $defs / zones_identifier / maxLengthRemoved value: -32 - removed
Input schema / properties / payload / $defs / zones_identifier / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_image_resizing_value / $refAdded value: +"#/$defs/zones_image_resizing_value" - removed
Input schema / properties / payload / $defs / zones_image_resizing_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_image_resizing_value / descriptionRemoved value: -"Whether the feature is enabled, disabled, or enabled in `open proxy` mode." - removed
Input schema / properties / payload / $defs / zones_image_resizing_value / enumRemoved value: -[ - "on", - "off", - "open" -] - removed
Input schema / properties / payload / $defs / zones_image_resizing_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_ip_geolocation_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / properties / payload / $defs / zones_ip_geolocation_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_ip_geolocation_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_ip_geolocation_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_ip_geolocation_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_ipv6_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_ipv6_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_ipv6_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_ipv6_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_ipv6_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_max_upload_value / $refAdded value: +"#/$defs/zones_max_upload_value" - removed
Input schema / properties / payload / $defs / zones_max_upload_value / defaultRemoved value: -100 - removed
Input schema / properties / payload / $defs / zones_max_upload_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: The size depends on the plan level of the zone. (Enterprise = 5000, Business = 200, Pro = 100, Free = 100)" - removed
Input schema / properties / payload / $defs / zones_max_upload_value / enumRemoved value: -[ - 100, - 125, - 150, - 175, - 200, - 225, - 250, - 275, - 300, - 325, - 350, - 375, - 400, - 425, - 450, - 475, - 500, - 1000, - 1500, - 2000, - 2500, - 3000, - 3500, - 4000, - 4500, - 5000 -] - removed
Input schema / properties / payload / $defs / zones_max_upload_value / typeRemoved value: -"integer" - added
Input schema / properties / payload / $defs / zones_min_tls_version_value / $refAdded value: +"#/$defs/zones_min_tls_version_value" - removed
Input schema / properties / payload / $defs / zones_min_tls_version_value / defaultRemoved value: -"1.0" - removed
Input schema / properties / payload / $defs / zones_min_tls_version_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_min_tls_version_value / enumRemoved value: -[ - "1.0", - "1.1", - "1.2", - "1.3" -] - removed
Input schema / properties / payload / $defs / zones_min_tls_version_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_mirage_value / $refAdded value: +"#/$defs/zones_mirage_value" - removed
Input schema / properties / payload / $defs / zones_mirage_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_mirage_value / deprecatedRemoved value: -true - removed
Input schema / properties / payload / $defs / zones_mirage_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_mirage_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_mirage_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_nel_value / $refAdded value: +"#/$defs/zones_nel_value" - removed
Input schema / properties / payload / $defs / zones_nel_value / defaultRemoved value: -{ - "enabled": false -} - removed
Input schema / properties / payload / $defs / zones_nel_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_nel_value / propertiesRemoved value: -{ - "enabled": { - "default": false, - "type": "boolean" - } -} - removed
Input schema / properties / payload / $defs / zones_nel_value / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / zones_opportunistic_encryption_value / $refAdded value: +"#/$defs/zones_automatic_https_rewrites_value" - removed
Input schema / properties / payload / $defs / zones_opportunistic_encryption_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_opportunistic_encryption_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Default value depends on the zone's plan level." - removed
Input schema / properties / payload / $defs / zones_opportunistic_encryption_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_opportunistic_encryption_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_opportunistic_onion_value / $refAdded value: +"#/$defs/zones_opportunistic_onion_value" - removed
Input schema / properties / payload / $defs / zones_opportunistic_onion_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_opportunistic_onion_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Default value depends on the zone's plan level." - removed
Input schema / properties / payload / $defs / zones_opportunistic_onion_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_opportunistic_onion_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_orange_to_orange_value / $refAdded value: +"#/$defs/zones_orange_to_orange_value" - removed
Input schema / properties / payload / $defs / zones_orange_to_orange_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_orange_to_orange_value / deprecatedRemoved value: -true - removed
Input schema / properties / payload / $defs / zones_orange_to_orange_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_orange_to_orange_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_orange_to_orange_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_origin_error_page_pass_thru_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_origin_error_page_pass_thru_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_origin_error_page_pass_thru_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_origin_error_page_pass_thru_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_origin_error_page_pass_thru_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_polish_value / $refAdded value: +"#/$defs/zones_polish_value" - removed
Input schema / properties / payload / $defs / zones_polish_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_polish_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_polish_value / enumRemoved value: -[ - "off", - "lossless", - "lossy" -] - removed
Input schema / properties / payload / $defs / zones_polish_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_pre_render_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_pre_render_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_pre_render_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_pre_render_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_pre_render_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_prefetch_preload_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_prefetch_preload_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_prefetch_preload_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_prefetch_preload_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_prefetch_preload_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_privacy_pass_value / $refAdded value: +"#/$defs/zones_privacy_pass_value" - removed
Input schema / properties / payload / $defs / zones_privacy_pass_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_privacy_pass_value / deprecatedRemoved value: -true - removed
Input schema / properties / payload / $defs / zones_privacy_pass_value / descriptionRemoved value: -"Value of the Privacy Pass v1 (deprecated) zone setting" - removed
Input schema / properties / payload / $defs / zones_privacy_pass_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_privacy_pass_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_proxy_read_timeout_value / $refAdded value: +"#/$defs/zones_proxy_read_timeout_value" - removed
Input schema / properties / payload / $defs / zones_proxy_read_timeout_value / defaultRemoved value: -125 - removed
Input schema / properties / payload / $defs / zones_proxy_read_timeout_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Value must be between 1 and 6000" - removed
Input schema / properties / payload / $defs / zones_proxy_read_timeout_value / typeRemoved value: -"number" - added
Input schema / properties / payload / $defs / zones_pseudo_ipv4_value / $refAdded value: +"#/$defs/zones_pseudo_ipv4_value" - removed
Input schema / properties / payload / $defs / zones_pseudo_ipv4_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_pseudo_ipv4_value / descriptionRemoved value: -"Value of the Pseudo IPv4 setting." - removed
Input schema / properties / payload / $defs / zones_pseudo_ipv4_value / enumRemoved value: -[ - "off", - "add_header", - "overwrite_header" -] - removed
Input schema / properties / payload / $defs / zones_pseudo_ipv4_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_redirects_for_ai_training_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_redirects_for_ai_training_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_redirects_for_ai_training_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_redirects_for_ai_training_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_redirects_for_ai_training_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_replace_insecure_js_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_replace_insecure_js_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_replace_insecure_js_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_replace_insecure_js_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_replace_insecure_js_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_response_buffering_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_response_buffering_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_response_buffering_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_response_buffering_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_response_buffering_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_rocket_loader_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_rocket_loader_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_rocket_loader_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_rocket_loader_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_rocket_loader_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_search_for_agents_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_search_for_agents_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_search_for_agents_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_search_for_agents_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_search_for_agents_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_security_header_value / $refAdded value: +"#/$defs/zones_security_header_value" - removed
Input schema / properties / payload / $defs / zones_security_header_value / defaultRemoved value: -{ - "strict_transport_security": { - "enabled": true, - "include_subdomains": true, - "max_age": 86400, - "nosniff": true, - "preload": false - } -} - removed
Input schema / properties / payload / $defs / zones_security_header_value / propertiesRemoved value: -{ - "strict_transport_security": { - "description": "Strict Transport Security.", - "properties": { - "enabled": { - "description": "Whether or not strict transport security is enabled.", - "type": "boolean" - }, - "include_subdomains": { - "description": "Include all subdomains for strict transport security.", - "type": "boolean" - }, - "max_age": { - "description": "Max age in seconds of the strict transport security.", - "type": "number" - }, - "nosniff": { - "description": "Whether or not to include 'X-Content-Type-Options: nosniff' header.", - "type": "boolean" - }, - "preload": { - "description": "Enable automatic preload of the HSTS configuration.", - "type": "boolean" - } - }, - "type": "object" - } -} - removed
Input schema / properties / payload / $defs / zones_security_header_value / typeRemoved value: -"object" - added
Input schema / properties / payload / $defs / zones_security_level_value / $refAdded value: +"#/$defs/zones_security_level_value" - removed
Input schema / properties / payload / $defs / zones_security_level_value / defaultRemoved value: -"medium" - removed
Input schema / properties / payload / $defs / zones_security_level_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_security_level_value / enumRemoved value: -[ - "off", - "essentially_off", - "low", - "medium", - "high", - "under_attack" -] - removed
Input schema / properties / payload / $defs / zones_security_level_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_server_side_exclude_value / $refAdded value: +"#/$defs/zones_always_online_value" - removed
Input schema / properties / payload / $defs / zones_server_side_exclude_value / defaultRemoved value: -"on" - removed
Input schema / properties / payload / $defs / zones_server_side_exclude_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_server_side_exclude_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_server_side_exclude_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_setting_name / $refAdded value: +"#/$defs/zones_setting_name" - removed
Input schema / properties / payload / $defs / zones_setting_name / descriptionRemoved value: -"Setting name" - removed
Input schema / properties / payload / $defs / zones_setting_name / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_setting_value / $refAdded value: +"#/$defs/zones_setting_value" - removed
Input schema / properties / payload / $defs / zones_setting_value / oneOfRemoved value: -[ - { - "$ref": "#/$defs/zones_0rtt_value" - }, - { - "$ref": "#/$defs/zones_advanced_ddos_value" - }, - { - "$ref": "#/$defs/zones_cache-rules_aegis_value" - }, - { - "$ref": "#/$defs/zones_always_online_value" - }, - { - "$ref": "#/$defs/zones_always_use_https_value" - }, - { - "$ref": "#/$defs/zones_automatic_https_rewrites_value" - }, - { - "$ref": "#/$defs/zones_brotli_value" - }, - { - "$ref": "#/$defs/zones_browser_cache_ttl_value" - }, - { - "$ref": "#/$defs/zones_browser_check_value" - }, - { - "$ref": "#/$defs/zones_cache_level_value" - }, - { - "$ref": "#/$defs/zones_challenge_ttl_value" - }, - { - "$ref": "#/$defs/zones_china_network_enabled_value" - }, - { - "$ref": "#/$defs/zones_content_converter_value" - }, - { - "$ref": "#/$defs/zones_ciphers_value" - }, - { - "$ref": "#/$defs/zones_cname_flattening_value" - }, - { - "$ref": "#/$defs/zones_development_mode_value" - }, - { - "$ref": "#/$defs/zones_early_hints_value" - }, - { - "$ref": "#/$defs/zones_edge_cache_ttl_value" - }, - { - "$ref": "#/$defs/zones_email_obfuscation_value" - }, - { - "$ref": "#/$defs/zones_h2_prioritization_value" - }, - { - "$ref": "#/$defs/zones_hotlink_protection_value" - }, - { - "$ref": "#/$defs/zones_http2_value" - }, - { - "$ref": "#/$defs/zones_http3_value" - }, - { - "$ref": "#/$defs/zones_image_resizing_value" - }, - { - "$ref": "#/$defs/zones_ip_geolocation_value" - }, - { - "$ref": "#/$defs/zones_ipv6_value" - }, - { - "$ref": "#/$defs/zones_max_upload_value" - }, - { - "$ref": "#/$defs/zones_min_tls_version_value" - }, - { - "$ref": "#/$defs/zones_mirage_value" - }, - { - "$ref": "#/$defs/zones_nel_value" - }, - { - "$ref": "#/$defs/zones_opportunistic_encryption_value" - }, - { - "$ref": "#/$defs/zones_opportunistic_onion_value" - }, - { - "$ref": "#/$defs/zones_orange_to_orange_value" - }, - { - "$ref": "#/$defs/zones_origin_error_page_pass_thru_value" - }, - { - "$ref": "#/$defs/zones_cache-rules_origin_h2_max_streams_value" - }, - { - "$ref": "#/$defs/zones_cache-rules_origin_max_http_version_value" - }, - { - "$ref": "#/$defs/zones_polish_value" - }, - { - "$ref": "#/$defs/zones_prefetch_preload_value" - }, - { - "$ref": "#/$defs/zones_pre_render_value" - }, - { - "$ref": "#/$defs/zones_privacy_pass_value" - }, - { - "$ref": "#/$defs/zones_proxy_read_timeout_value" - }, - { - "$ref": "#/$defs/zones_pseudo_ipv4_value" - }, - { - "$ref": "#/$defs/zones_redirects_for_ai_training_value" - }, - { - "$ref": "#/$defs/zones_replace_insecure_js_value" - }, - { - "$ref": "#/$defs/zones_response_buffering_value" - }, - { - "$ref": "#/$defs/zones_rocket_loader_value" - }, - { - "$ref": "#/$defs/zones_automatic_platform_optimization" - }, - { - "$ref": "#/$defs/zones_search_for_agents_value" - }, - { - "$ref": "#/$defs/zones_security_header_value" - }, - { - "$ref": "#/$defs/zones_security_level_value" - }, - { - "$ref": "#/$defs/zones_server_side_exclude_value" - }, - { - "$ref": "#/$defs/zones_sha1_support_value" - }, - { - "$ref": "#/$defs/zones_sort_query_string_for_cache_value" - }, - { - "$ref": "#/$defs/zones_ssl_value" - }, - { - "$ref": "#/$defs/zones_tls_1_2_only_value" - }, - { - "$ref": "#/$defs/zones_tls_1_3_value" - }, - { - "$ref": "#/$defs/zones_tls_client_auth_value" - }, - { - "$ref": "#/$defs/zones_true_client_ip_header_value" - }, - { - "$ref": "#/$defs/zones_waf_value" - }, - { - "$ref": "#/$defs/zones_webmcp_enabled_value" - }, - { - "$ref": "#/$defs/zones_webmcp_packs_value" - }, - { - "$ref": "#/$defs/zones_webp_value" - }, - { - "$ref": "#/$defs/zones_websockets_value" - } -] - added
Input schema / properties / payload / $defs / zones_sha1_support_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_sha1_support_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_sha1_support_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_sha1_support_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_sha1_support_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_sort_query_string_for_cache_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_sort_query_string_for_cache_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_sort_query_string_for_cache_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_sort_query_string_for_cache_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_sort_query_string_for_cache_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_ssl_recommender_enabled / $refAdded value: +"#/$defs/zones_ssl_recommender_enabled" - removed
Input schema / properties / payload / $defs / zones_ssl_recommender_enabled / defaultRemoved value: -false - removed
Input schema / properties / payload / $defs / zones_ssl_recommender_enabled / descriptionRemoved value: -"ssl-recommender enrollment setting." - removed
Input schema / properties / payload / $defs / zones_ssl_recommender_enabled / typeRemoved value: -"boolean" - added
Input schema / properties / payload / $defs / zones_ssl_value / $refAdded value: +"#/$defs/zones_ssl_value" - removed
Input schema / properties / payload / $defs / zones_ssl_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_ssl_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Depends on the zone's plan level" - removed
Input schema / properties / payload / $defs / zones_ssl_value / enumRemoved value: -[ - "off", - "flexible", - "full", - "strict" -] - removed
Input schema / properties / payload / $defs / zones_ssl_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_tls_1_2_only_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_tls_1_2_only_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_tls_1_2_only_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_tls_1_2_only_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_tls_1_2_only_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_tls_1_3_value / $refAdded value: +"#/$defs/zones_tls_1_3_value" - removed
Input schema / properties / payload / $defs / zones_tls_1_3_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_tls_1_3_value / descriptionRemoved value: -"Value of the zone setting.\nNotes: Default value depends on the zone's plan level." - removed
Input schema / properties / payload / $defs / zones_tls_1_3_value / enumRemoved value: -[ - "on", - "off", - "zrt" -] - removed
Input schema / properties / payload / $defs / zones_tls_1_3_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_tls_client_auth_value / $refAdded value: +"#/$defs/zones_tls_client_auth_value" - removed
Input schema / properties / payload / $defs / zones_tls_client_auth_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_tls_client_auth_value / descriptionRemoved value: -"value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_tls_client_auth_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_tls_client_auth_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_true_client_ip_header_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_true_client_ip_header_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_true_client_ip_header_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_true_client_ip_header_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_true_client_ip_header_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_waf_value / $refAdded value: +"#/$defs/zones_always_use_https_value" - removed
Input schema / properties / payload / $defs / zones_waf_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_waf_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_waf_value / enumRemoved value: -[ - "on", - "off" -] - removed
Input schema / properties / payload / $defs / zones_waf_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_webmcp_enabled_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_webmcp_enabled_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_webmcp_enabled_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_webmcp_enabled_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_webmcp_enabled_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_webmcp_packs_value / $refAdded value: +"#/$defs/zones_webmcp_packs_value" - removed
Input schema / properties / payload / $defs / zones_webmcp_packs_value / defaultRemoved value: -"" - removed
Input schema / properties / payload / $defs / zones_webmcp_packs_value / descriptionRemoved value: -"Comma-separated list of WebMCP tool-pack names to activate for this\nzone (for example, \"c2pa,mcp-server-client\"), surfaced to the injected\nbridge as the data-packs attribute. An empty value clears the override\nso the bridge uses its built-in default pack set." - removed
Input schema / properties / payload / $defs / zones_webmcp_packs_value / maxLengthRemoved value: -256 - removed
Input schema / properties / payload / $defs / zones_webmcp_packs_value / patternRemoved value: -"^([a-z0-9]+(-[a-z0-9]+)*(,[a-z0-9]+(-[a-z0-9]+)*)*)?$" - removed
Input schema / properties / payload / $defs / zones_webmcp_packs_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_webp_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_webp_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_webp_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_webp_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_webp_value / typeRemoved value: -"string" - added
Input schema / properties / payload / $defs / zones_websockets_value / $refAdded value: +"#/$defs/zones_brotli_value" - removed
Input schema / properties / payload / $defs / zones_websockets_value / defaultRemoved value: -"off" - removed
Input schema / properties / payload / $defs / zones_websockets_value / descriptionRemoved value: -"Value of the zone setting." - removed
Input schema / properties / payload / $defs / zones_websockets_value / enumRemoved value: -[ - "off", - "on" -] - removed
Input schema / properties / payload / $defs / zones_websockets_value / typeRemoved value: -"string"
29 tool updates
v2.0.0- First observed
analytics_query - First observed
apply_dns_batch - First observed
batch_dns_records - First observed
create_dns_record - First observed
create_zone_ruleset - First observed
delete_dns_record - First observed
delete_zone_ruleset - First observed
get_dns_record - First observed
get_operation_schema - First observed
get_page_rule - First observed
get_zone - First observed
get_zone_entrypoint - First observed
get_zone_ruleset - First observed
get_zone_setting - First observed
list_accounts - First observed
list_dns_records - First observed
list_page_rules - First observed
list_provider_accounts - First observed
list_workers - First observed
list_zone_rulesets - First observed
list_zones - First observed
overwrite_dns_record - First observed
preview_dns_batch - First observed
preview_operation - First observed
purge_cache - First observed
query_pages - First observed
update_dns_record - First observed
update_zone_ruleset - First observed
update_zone_setting
TDQS
Scored across 29 tools
Most tools target distinct Cloudflare resources and actions, but several overlapping pairs create confusion: update_dns_record vs overwrite_dns_record, batch_dns_records vs apply_dns_batch, preview_dns_batch vs preview_operation, and list_accounts vs list_provider_accounts. Descriptions help somewhat, but an agent could still misselect among batch/preview/apply tools.
Nearly all tools use snake_case verb_noun naming such as create_dns_record, list_zones, and delete_zone_ruleset. Minor deviations like analytics_query and batch_dns_records slightly break the pattern, but the set remains predictable overall.
With 29 tools, the server is heavy for a single MCP surface. While Cloudflare is a broad platform, the count exceeds the typical well-scoped range of 3-15 and includes several specialized or overlapping operations that could be consolidated.
DNS records and zone rulesets have strong CRUD coverage, but other apparent domains are incomplete: Page Rules only support get/list, Workers only list, and zones lack create/delete operations. These gaps are notable but not fatal for common DNS and ruleset workflows.
Maintenance
Related MCP Connectors
29 pay-per-call DNS, SEO, SSL, security, and dev tools for AI agents. x402, no API key.
- mcp-serverOAuthcom.make
Give your AI agents the tools to build, manage, and run automation workflows.
Discover, inspect and run 63,000+ agent tools from one balance. Pay per call, no subscriptions.
Zero-trust gateway for AI agents: score tool calls, verify agent cards, enforce policy, audit.
Related MCP Servers
- AlicenseAqualityBmaintenanceEnables AI assistants to manage Cloudflare resources through natural language, including DNS records, zone management, Workers KV storage, cache purging, and analytics. Supports comprehensive Cloudflare operations with secure API token authentication.132MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI agents to interact with the Cloudflare REST API for managing DNS records, zones, and other Cloudflare resources.MIT
- AlicenseAqualityDmaintenanceEnables AI assistants to manage Cloudflare DNS zones and records, including listing, creating, updating, and deleting DNS records through natural language.6MIT
- AlicenseNot gradedqualityCmaintenanceEnables AI agents to manage Cloudflare DNS records, including listing zones and records, and creating, updating, or deleting DNS records.43 npmMIT