> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Cloudflare Api Key

> Cloudflare provides a suite of services to enhance the security, performance, and reliability of websites and applications.

![Cloudflare Api Key logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/cloudflare_api_key.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=2a48715a5c9b796a9ba1159ff3b71fb0)

* **Category:** security & identity tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 40
* **Triggers:** 0
* **Slug:** `CLOUDFLARE_API_KEY`
* **Version:** 20261103\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Configure Email Routing DNS
>
> **Slug:** `CLOUDFLARE_API_KEY_CONFIGURE_EMAIL_ROUTING_DNS`
>
> Enable Email Routing and add and lock its required MX and SPF records.
>
> #### Input Parameters
>
> **name** `string`
>
> Domain name of the zone.
>
> **zone\_id** `string` *required*
>
> Identifier of the zone for which to enable Email Routing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create DNS Record
>
> **Slug:** `CLOUDFLARE_API_KEY_CREATE_DNS_RECORD`
>
> Tool to create a new DNS record in a Cloudflare zone. Use when you need to add a record (A, CNAME, TXT, MX, etc.) to a specified zone.
>
> #### Input Parameters
>
> **ttl** `integer`
>
> Time to live for DNS record in seconds; 1 means automatic (Cloudflare default).
>
> **name** `string` *required*
>
> Fully qualified DNS record name in Punycode.
>
> **tags** `array`
>
> Custom tags in the form "name:value".
>
> **type** `string ("A" | "AAAA" | "CNAME" | "MX" | "TXT" | "SRV" | "LOC" | "SPF" | "CERT" | "DNSKEY" | "DS" | "NAPTR" | "SMIMEA" | "SSHFP" | "TLSA" | "URI" | "CAA")` *required*
>
> DNS record type.
>
> **comment** `string`
>
> Free-form comment for the DNS record.
>
> **content** `string`
>
> Record content; for types like A/AAAA use IP address, for CNAME use target hostname, etc.
>
> **proxied** `boolean`
>
> Whether the record is receiving the performance and security benefits of Cloudflare.
>
> **zone\_id** `string` *required*
>
> Zone identifier in which to create the DNS record.
>
> **settings** `object`
>
> Settings specific to A record when proxied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Email Routing Rule
>
> **Slug:** `CLOUDFLARE_API_KEY_CREATE_EMAIL_ROUTING_RULE`
>
> Create an Email Routing rule for a Cloudflare zone.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable name for the routing rule.
>
> **source** `string ("api" | "wrangler")`
>
> System that manages the rule; defaults to api.
>
> **actions** `array` *required*
>
> Actions to perform when an inbound email matches the rule.
>
> **enabled** `boolean`
>
> Whether the rule is active immediately after creation.
>
> **zone\_id** `string` *required*
>
> Identifier of the zone in which to create the rule.
>
> **matchers** `array` *required*
>
> Conditions that select inbound email for the rule.
>
> **priority** `number`
>
> Processing priority of the routing rule (minimum 0).
>
> **owner\_worker\_tag** `string`
>
> Worker owner tag, required when source is wrangler.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zone Lockdown Rule
>
> **Slug:** `CLOUDFLARE_API_KEY_CREATE_LOCKDOWN_RULE`
>
> Tool to create a Zone Lockdown rule. Use when you need to restrict access to specific URL patterns to defined IPs/CIDR ranges. Use after confirming zone\_id.
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> URLs to lock down; supports simple wildcard '\*' patterns.
>
> **paused** `boolean`
>
> Whether to start the rule in a paused state.
>
> **zone\_id** `string` *required*
>
> Zone identifier.
>
> **priority** `integer`
>
> Processing priority (lower numbers run first).
>
> **description** `string`
>
> Optional summary of the rule.
>
> **configurations** `array` *required*
>
> One or more sources to allow (IP or CIDR ranges).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Pages Deployment
>
> **Slug:** `CLOUDFLARE_API_KEY_CREATE_PAGES_DEPLOYMENT`
>
> Create a Cloudflare Pages deployment from a Git branch or Direct Upload manifest.
>
> #### Input Parameters
>
> **branch** `string`
>
> Git branch whose HEAD should be deployed. Defaults to the project's production branch.
>
> **manifest** `object`
>
> Direct Upload mapping of deployment paths to previously uploaded content hashes.
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier.
>
> **commit\_hash** `string`
>
> Git commit SHA associated with the deployment.
>
> **routes\_file** `object`
>
> Pages routes JSON file.
>
> **commit\_dirty** `boolean`
>
> Whether the associated Git working tree has uncommitted changes.
>
> **headers\_file** `object`
>
> Pages headers configuration file.
>
> **project\_name** `string` *required*
>
> Pages project name.
>
> **worker\_bundle** `object`
>
> Worker bundle file. Mutually exclusive with worker\_script.
>
> **worker\_script** `object`
>
> Worker JavaScript file. Mutually exclusive with worker\_bundle.
>
> **commit\_message** `string`
>
> Git commit message associated with the deployment.
>
> **redirects\_file** `object`
>
> Pages redirects configuration file.
>
> **wrangler\_config\_hash** `string`
>
> Wrangler configuration file hash.
>
> **pages\_build\_output\_dir** `string`
>
> Build output directory path.
>
> **functions\_routing\_config** `object`
>
> Pages Functions routing configuration JSON file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Rule in Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_CREATE_RULE_IN_RULESET`
>
> Tool to add a rule to an existing ruleset. Use when you need to append or insert a new rule in a Cloudflare ruleset.
>
> #### Input Parameters
>
> **rule** `object` *required*
>
> Definition of the rule to add
>
> **zone\_id** `string`
>
> Zone identifier; required if using zones segment
>
> **account\_id** `string`
>
> Account identifier; required if using accounts segment
>
> **ruleset\_id** `string` *required*
>
> ID of the target ruleset
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Segment for owner: 'accounts' or 'zones'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_CREATE_RULESET`
>
> Creates a new Cloudflare ruleset at account or zone scope. Rulesets contain rules that control traffic behavior (firewall, rate limiting, redirects, etc.). First use List Zones to get a zone\_id, then specify the phase (e.g., 'http\_request\_firewall\_custom' for WAF rules).
>
> #### Input Parameters
>
> **kind** `string ("custom" | "root" | "zone")` *required*
>
> Type of ruleset. 'custom' for user-defined rules, 'root' for account-level entrypoint, 'zone' for zone-level entrypoint.
>
> **name** `string` *required*
>
> Human-readable name for the ruleset (e.g., 'Production Firewall Rules').
>
> **phase** `string` *required*
>
> Execution phase determining when rules run. Common phases: 'http\_request\_firewall\_custom' (WAF), 'http\_config\_settings' (config), 'ddos\_l7' (DDoS), 'http\_request\_transform' (URL rewrite), 'http\_response\_headers\_transform' (response headers).
>
> **rules** `array`
>
> List of rules to include. Can be empty and rules added later via Create Rule in Ruleset.
>
> **description** `string`
>
> Human-readable description of the ruleset's purpose.
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Scope for the ruleset. Use 'zones' for zone-level rulesets or 'accounts' for account-level rulesets.
>
> **account\_or\_zone\_id** `string` *required*
>
> The 32-character identifier of the account or zone. Get zone IDs from List Zones, account IDs from your Cloudflare dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete DNS Record
>
> **Slug:** `CLOUDFLARE_API_KEY_DELETE_DNS_RECORD`
>
> Tool to delete a DNS record. Use when you need to remove a specific DNS record from a zone after confirming both zone and record IDs.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> Cloudflare zone identifier. Obtain this from the List Zones action or the Cloudflare dashboard under the zone's Overview page.
>
> **dns\_record\_id** `string` *required*
>
> DNS record identifier to delete. Obtain this from the List DNS Records action for the target zone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete DNSSEC
>
> **Slug:** `CLOUDFLARE_API_KEY_DELETE_DNSSEC`
>
> Tool to delete DNSSEC records for a zone. Use after disabling DNSSEC at the registrar to remove DNSSEC configuration.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> Zone identifier to delete DNSSEC for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Rule from Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_DELETE_RULE_FROM_RULESET`
>
> Tool to delete a specific rule from a ruleset. Use when you need to remove an outdated or incorrect rule from an account or zone ruleset after confirming IDs.
>
> #### Input Parameters
>
> **rule\_id** `string` *required*
>
> 32-character hex identifier of the rule to delete from the ruleset
>
> **ruleset\_id** `string` *required*
>
> 32-character hex identifier of the ruleset containing the rule to delete
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Scope for the ruleset: use 'accounts' for account-level rulesets or 'zones' for zone-level rulesets
>
> **account\_or\_zone\_id** `string` *required*
>
> 32-character hex identifier of the account (if accounts\_or\_zones='accounts') or zone (if accounts\_or\_zones='zones')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_DELETE_RULESET`
>
> Tool to delete all versions of a ruleset. Use when you need to remove a ruleset from an account or zone after confirming no references exist.
>
> #### Input Parameters
>
> **ruleset\_id** `string` *required*
>
> Unique identifier of the ruleset to delete.
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Scope of the ruleset. Must be 'accounts' or 'zones'.
>
> **account\_or\_zone\_id** `string` *required*
>
> Account ID if scope is 'accounts', or Zone ID if scope is 'zones'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a zone
>
> **Slug:** `CLOUDFLARE_API_KEY_DELETE_ZONE`
>
> Tool to delete an existing zone. Use after confirming the zone\_id to permanently remove the zone.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> Zone identifier to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract Data with Clairic
>
> **Slug:** `CLOUDFLARE_API_KEY_EXTRACT_WITH_CLAIRIC`
>
> Extract typed values and calibrated estimates from text or embedded images.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.10 per 1 million input tokens; output tokens free
>
> #### Input Parameters
>
> **state** `string`
>
> Text to extract from. It must contain non-whitespace text unless images are supplied. Clairic reads about 65,000 input tokens; longer input is truncated, still charged, and reported with truncated set to true.
>
> **fields** `object` *required*
>
> Named typed values to extract; include at least one field.
>
> **images** `array`
>
> Up to four embedded PNG, JPEG, or WebP images, each as a data URL or an object containing content\_type and base64. The whole Composio request must be under 4.5 MiB, which allows about 3.3 MiB of decoded image data in total after base64 encoding.
>
> **account\_id** `string`
>
> Cloudflare account identifier. Required when using your own Cloudflare API token; ignored for Composio-managed (Instant) calls.
>
> **reference\_date** `string`
>
> ISO date that anchors dates written without a year.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Cloudflare IP Addresses
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_CLOUDFLARE_IP_ADDRESSES`
>
> Tool to retrieve IP addresses used on the Cloudflare or JD Cloud network. Use when you need to obtain the list of IPv4 and IPv6 CIDR blocks used by Cloudflare's infrastructure or JD Cloud data centers.
>
> #### Input Parameters
>
> **networks** `string`
>
> Specify as 'jdcloud' to retrieve IP ranges utilized by JD Cloud data centers. If not specified, returns Cloudflare IP ranges.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Entrypoint Ruleset Version
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_ENTRYPOINT_RULESET_VERSION`
>
> Retrieves a specific historical version of an entry point ruleset from Cloudflare. Entry point rulesets are phase-specific and define the rules that execute during a particular phase of request/response processing. This tool fetches a specific version, allowing you to view rules as they existed at a particular point in time. Use cases: - Audit historical rule configurations - Compare rule changes between versions - Rollback analysis (view what rules looked like before a change) - Debug issues by examining past ruleset states Prerequisites: - Requires a valid account\_id or zone\_id (use List Zones to get zone IDs) - Requires knowing the ruleset phase (e.g., 'http\_request\_firewall\_custom') - Requires knowing the version number to fetch
>
> #### Input Parameters
>
> **ruleset\_phase** `string` *required*
>
> The execution phase of the entry point ruleset. Common phases include: 'http\_request\_firewall\_custom' (custom WAF rules), 'http\_request\_firewall\_managed' (managed WAF), 'ddos\_l4' (Layer 4 DDoS), 'ddos\_l7' (Layer 7 DDoS), 'http\_request\_transform' (URL rewrite), 'http\_response\_headers\_transform' (response headers), 'magic\_transit' (Magic Transit), 'http\_ratelimit' (rate limiting), 'http\_request\_sbfm' (Super Bot Fight Mode)
>
> **ruleset\_version** `string` *required*
>
> The numeric version identifier of the entry point ruleset to retrieve (e.g., '1', '2', '3')
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Scope for the ruleset: use 'accounts' for account-level rulesets or 'zones' for zone-level rulesets
>
> **account\_or\_zone\_id** `string` *required*
>
> The 32-character alphanumeric identifier of the account (when accounts\_or\_zones='accounts') or zone (when accounts\_or\_zones='zones')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lockdown Rule
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_LOCKDOWN_RULE`
>
> Tool to get a Zone Lockdown rule. Use when you need to fetch details of a specific lockdown rule by its ID within a Cloudflare zone.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> Identifier of the Cloudflare zone (max length 32)
>
> **lockdown\_id** `string` *required*
>
> Unique identifier of the Zone Lockdown rule (max length 32)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pages Project
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_PAGES_PROJECT`
>
> Retrieve one Cloudflare Pages project and its complete configuration.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier.
>
> **project\_name** `string` *required*
>
> Cloudflare Pages project name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pages Upload Token
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_PAGES_UPLOAD_TOKEN`
>
> Return a sensitive short-lived JWT for Pages Direct Upload; do not log or persist it.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier
>
> **project\_name** `string` *required*
>
> Pages project name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get R2 Object
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_R2_OBJECT`
>
> Downloads an object's stored content and metadata from a Cloudflare R2 bucket.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Cloudflare account ID that owns the R2 bucket.
>
> **object\_key** `string` *required*
>
> Key of the object to download. Path separators in the key are preserved.
>
> **bucket\_name** `string` *required*
>
> Name of the R2 bucket containing the object.
>
> **jurisdiction** `string ("default" | "eu" | "us" | "fedramp" | "fedramp-high")`
>
> R2 jurisdiction in which the bucket is located.
>
> **if\_none\_match** `string`
>
> Download only if the object's ETag does not match this value.
>
> **if\_modified\_since** `string`
>
> Download only if modified since this RFC 7231 HTTP-date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Regional Tiered Cache
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_REGIONAL_TIERED_CACHE`
>
> Tool to get the regional tiered cache setting for a zone. Use when you need to verify if regional tiered cache is enabled for performance optimization after zone activation.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> Identifier of the Cloudflare zone (max 32 characters)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_RULESET`
>
> Tool to fetch the latest version of a ruleset by ID. Use after you have the ruleset scope and ID.
>
> #### Input Parameters
>
> **zone\_id** `string`
>
> DNS zone ID; required if accounts\_or\_zones='zones', mutually exclusive with account\_id.
>
> **account\_id** `string`
>
> Cloudflare account ID; required if accounts\_or\_zones='accounts', mutually exclusive with zone\_id.
>
> **ruleset\_id** `string` *required*
>
> The unique ID of the ruleset to retrieve.
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Must be 'accounts' or 'zones' to select the account- or zone-level endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Schedules
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_WORKER_SCHEDULES`
>
> Get the Cron Triggers configured for one Worker script.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier
>
> **script\_name** `string` *required*
>
> Name of the Worker script
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Worker Subdomain And Schedules
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_WORKER_SUBDOMAIN_AND_SCHEDULES`
>
> Read a Worker's workers.dev subdomain routing and cron schedules. This does not return the script settings resource (bindings, compatibility\_date, logpush, ...).
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier.
>
> **worker\_name** `string` *required*
>
> Worker name used by both the Worker and script schedules endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zone Details
>
> **Slug:** `CLOUDFLARE_API_KEY_GET_ZONE_DETAILS`
>
> Tool to get details for a specific zone. Use when you need detailed zone metadata by ID.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> Identifier for the zone (max length 32)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Accounts
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_ACCOUNTS`
>
> List accounts accessible to the credential for downstream account operations.
>
> #### Input Parameters
>
> **name** `string`
>
> Account name to filter by.
>
> **page** `integer`
>
> Page number to return, starting at 1.
>
> **per\_page** `integer`
>
> Maximum number of accounts to return per page, from 5 to 50.
>
> **direction** `string ("asc" | "desc")`
>
> Direction in which to order accounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List DNS Records
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_DNS_RECORDS`
>
> List, search, sort, and filter DNS records for a Cloudflare zone. Use this tool to retrieve DNS records (A, AAAA, CNAME, TXT, MX, etc.) for a zone. Supports filtering by record type, name, content, and proxy status. Results are paginated; use page and per\_page parameters for large record sets. Requires a valid zone\_id which can be obtained from the List Zones action.
>
> #### Input Parameters
>
> **name** `string`
>
> Filter by exact DNS record name (e.g., 'example.com' or 'sub.example.com'). Case-insensitive.
>
> **page** `integer`
>
> Page number for paginated results (minimum: 1, default: 1).
>
> **type** `string ("A" | "AAAA" | "CAA" | "CERT" | "CNAME" | "DNSKEY" | "DS" | "HTTPS" | "LOC" | "MX" | "NAPTR" | "NS" | "PTR" | "SMIMEA" | "SPF" | "SRV" | "SSHFP" | "SVCB" | "TLSA" | "TXT" | "URI")`
>
> Filter by DNS record type (e.g., A, AAAA, CNAME, TXT, MX).
>
> **match** `string ("any" | "all")`
>
> Logical operator for filters: 'all' (AND) matches all criteria, 'any' (OR) matches any criterion. Default: 'all'.
>
> **order** `string ("type" | "name" | "content" | "ttl" | "proxied")`
>
> Field to order results by. Default ordering is by type.
>
> **search** `string`
>
> Human-readable search query to filter records by name, content, or other properties simultaneously.
>
> **content** `string`
>
> Filter by exact record content (e.g., IP address for A records, target hostname for CNAME). Case-insensitive.
>
> **proxied** `boolean`
>
> Filter by Cloudflare proxy status. True = proxied through Cloudflare, False = DNS only.
>
> **zone\_id** `string` *required*
>
> Zone identifier (32-character hex string) to list DNS records for.
>
> **per\_page** `integer`
>
> Number of DNS records per page (minimum: 1, maximum: 5000, default: 100).
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction: 'asc' for ascending, 'desc' for descending. Default: 'asc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Routing Rules
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_EMAIL_ROUTING_RULES`
>
> List and filter Email Routing rules configured for a Cloudflare zone.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return (minimum 1, default 1).
>
> **enabled** `boolean`
>
> Filter rules by whether they are enabled.
>
> **zone\_id** `string` *required*
>
> Identifier of the zone whose Email Routing rules to list.
>
> **per\_page** `integer`
>
> Rules per page (minimum 5, maximum 50, default 20).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pages Deployments
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_PAGES_DEPLOYMENTS`
>
> List production or preview deployments for a Cloudflare Pages project.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return, starting at 1.
>
> **per\_page** `integer`
>
> Number of deployments to return per page.
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier.
>
> **environment** `string ("production" | "preview")`
>
> Deployment environment to return.
>
> **project\_name** `string` *required*
>
> Cloudflare Pages project name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List R2 Objects
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_R2_OBJECTS`
>
> List object metadata and keys in an R2 bucket with cursor pagination.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Opaque pagination cursor returned by a previous list response.
>
> **prefix** `string`
>
> Return only object keys that begin with this prefix.
>
> **per\_page** `integer`
>
> Maximum number of objects to return (1-1000, default 1000).
>
> **delimiter** `string`
>
> Single character used to group object keys by common prefix.
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier that owns the R2 bucket.
>
> **bucket\_name** `string` *required*
>
> Name of the R2 bucket whose objects should be listed.
>
> **start\_after** `string`
>
> Return object keys lexicographically after this key.
>
> **jurisdiction** `string ("default" | "eu" | "us" | "fedramp" | "fedramp-high")`
>
> R2 jurisdiction sent in the cf-r2-jurisdiction header.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Worker Build Triggers
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_WORKER_BUILD_TRIGGERS`
>
> List repository build triggers configured for a Worker external script ID.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier.
>
> **external\_script\_id** `string` *required*
>
> System-generated Worker tag; this is not the Worker name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Cloudflare Zones
>
> **Slug:** `CLOUDFLARE_API_KEY_LIST_ZONES`
>
> Tool to list, search, sort, and filter Cloudflare zones. Use when you need to retrieve a paginated list of zones available to the authenticated user.
>
> #### Input Parameters
>
> **name** `string`
>
> A domain name; supports the same operators as account.name.
>
> **page** `integer`
>
> Page number (min: 1, default: 1).
>
> **match** `string ("any" | "all")`
>
> Whether to match any or all search requirements (default: all).
>
> **order** `string ("name" | "status" | "account.id" | "account.name" | "plan.id")`
>
> Field to order by.
>
> **status** `string ("initializing" | "pending" | "active" | "moved")`
>
> Filter by zone status.
>
> **per\_page** `integer`
>
> Results per page (min: 5, max: 50, default: 20).
>
> **direction** `string ("asc" | "desc")`
>
> Direction to order zones.
>
> **account.id** `string`
>
> Filter by an account ID.
>
> **account.name** `string`
>
> Account name; supports operators: equal (default), not\_equal, starts\_with, ends\_with, contains, starts\_with\_case\_sensitive, ends\_with\_case\_sensitive, contains\_case\_sensitive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Overwrite DNS Record
>
> **Slug:** `CLOUDFLARE_API_KEY_OVERWRITE_DNS_RECORD`
>
> Overwrites a DNS record in a Cloudflare zone using the supported record fields, including type, name, content, TTL, proxy status, comments, tags, and settings.
>
> #### Input Parameters
>
> **ttl** `integer`
>
> Time to live for DNS record in seconds; 1 means automatic (Cloudflare default).
>
> **name** `string` *required*
>
> Fully qualified DNS record name in Punycode.
>
> **tags** `array`
>
> Custom tags in the form 'name:value'.
>
> **type** `string ("A" | "AAAA" | "CNAME" | "MX" | "TXT" | "SRV" | "LOC" | "SPF" | "CERT" | "DNSKEY" | "DS" | "NAPTR" | "SMIMEA" | "SSHFP" | "TLSA" | "URI" | "CAA")` *required*
>
> DNS record type.
>
> **comment** `string`
>
> Free-form comment for the DNS record.
>
> **content** `string`
>
> Record content; e.g., IPv4 address for A records, target hostname for CNAME, etc.
>
> **proxied** `boolean`
>
> Whether the record is receiving the performance and security benefits of Cloudflare.
>
> **zone\_id** `string` *required*
>
> Zone identifier containing the DNS record.
>
> **settings** `object`
>
> Type-specific settings object for proxied record; passed through to the API.
>
> **dns\_record\_id** `string` *required*
>
> Identifier of the DNS record to overwrite.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rerun Zone Activation Check
>
> **Slug:** `CLOUDFLARE_API_KEY_RERUN_ZONE_ACTIVATION_CHECK`
>
> Triggers a new activation check for a zone with 'pending' status. Use this after creating a zone or updating nameservers to verify that DNS propagation is complete and the zone can be activated. Rate limits apply: once every 5 minutes for paid plans (paygo/Enterprise) or once per hour for Free plans.
>
> #### Input Parameters
>
> **zone\_id** `string` *required*
>
> The unique identifier for the Cloudflare zone. This is a 32-character hexadecimal string that can be found in the Cloudflare dashboard or obtained from the List Zones API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Workers AI Model
>
> **Slug:** `CLOUDFLARE_API_KEY_RUN_WORKERS_AI_MODEL`
>
> Run a selected Workers AI model with model-specific JSON input.
>
> #### Input Parameters
>
> **input** `object`
>
> Model-specific JSON input. Streaming is unsupported; do not set stream to true.
>
> **account\_id** `string` *required*
>
> Cloudflare account identifier that provides Workers AI.
>
> **model\_name** `string` *required*
>
> Workers AI model name, including its namespace, such as @cf/meta/llama-3.1-8b-instruct.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update DNSSEC Status
>
> **Slug:** `CLOUDFLARE_API_KEY_UPDATE_DNSSEC_STATUS`
>
> Tool to update DNSSEC configuration for a zone. Use when you need to enable or disable DNSSEC or adjust DNSSEC options after confirming the zone ID.
>
> #### Input Parameters
>
> **status** `string ("active" | "disabled")`
>
> Desired DNSSEC state. Use 'active' to enable or 'disabled' to turn off DNSSEC.
>
> **zone\_id** `string` *required*
>
> Identifier of the zone to update.
>
> **dnssec\_presigned** `boolean`
>
> Allow transfer-in of a pre-signed zone without on-the-fly signing.
>
> **dnssec\_use\_nsec3** `boolean`
>
> Enable NSEC3 together with DNSSEC (commonly used when transferring from another provider).
>
> **dnssec\_multi\_signer** `boolean`
>
> Enable multi-signer DNSSEC so multiple providers can serve a signed zone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Lockdown Rule
>
> **Slug:** `CLOUDFLARE_API_KEY_UPDATE_LOCKDOWN_RULE`
>
> Updates a Zone Lockdown rule in a Cloudflare zone, supplying both the allowed IP addresses or CIDR ranges and the URL patterns.
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> List of URL patterns to restrict access for; wildcards supported (e.g., 'shop.example.com/\*').
>
> **paused** `boolean`
>
> Whether to pause the rule. When paused, the rule is inactive and does not block any traffic.
>
> **zone\_id** `string` *required*
>
> Identifier of the Cloudflare zone.
>
> **description** `string`
>
> Optional human-readable description of the rule's purpose.
>
> **lock\_downs\_id** `string` *required*
>
> Identifier of the Zone Lockdown rule to update.
>
> **configurations** `array` *required*
>
> List of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Rule in Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_UPDATE_RULE_IN_RULESET`
>
> Tool to update a specific rule in a ruleset. Use when you need to modify a rule's configuration or reorder it after reviewing its current settings.
>
> #### Input Parameters
>
> **rule** `object`
>
> Fields to update on a rule.
>
> **rule\_id** `string` *required*
>
> ID of the rule to update.
>
> **position** `object`
>
> Position for reordering a rule within its ruleset.
>
> **ruleset\_id** `string` *required*
>
> ID of the ruleset containing the rule.
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Scope type: 'accounts' for account rulesets or 'zones' for zone rulesets.
>
> **account\_or\_zone\_id** `string` *required*
>
> ID of the account or zone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Ruleset
>
> **Slug:** `CLOUDFLARE_API_KEY_UPDATE_RULESET`
>
> Update a Cloudflare ruleset, creating a new version. Use this to modify ruleset description, name, or rules. IMPORTANT: When updating rules, you must include ALL rules you want to keep - any rules not included will be removed. Cannot modify managed rulesets directly - use overrides instead.
>
> #### Input Parameters
>
> **kind** `string`
>
> Ruleset kind. Generally immutable after creation. Values: 'custom', 'root', 'zone', 'managed'.
>
> **name** `string`
>
> Human-readable name for the ruleset. Note: Cannot be changed for managed rulesets.
>
> **phase** `string`
>
> Execution phase. Common values: 'http\_request\_firewall\_custom', 'http\_config\_settings', 'ddos\_l7', 'http\_response\_headers\_transform'.
>
> **rules** `array`
>
> Complete list of rules for this ruleset version. WARNING: This replaces ALL existing rules - include every rule you want to keep.
>
> **ruleset\_id** `string` *required*
>
> The unique ID of the ruleset to update. Get this from create\_ruleset or get\_ruleset.
>
> **description** `string`
>
> Informative description of this ruleset version. Useful for tracking changes.
>
> **accounts\_or\_zones** `string ("accounts" | "zones")` *required*
>
> Scope of the ruleset. Use "accounts" for account-level rulesets or "zones" for zone-level rulesets.
>
> **account\_or\_zone\_id** `string` *required*
>
> The 32-character hexadecimal ID of the account or zone (depending on scope). Get this from list\_zones or list\_accounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Cloudflare Zone
>
> **Slug:** `CLOUDFLARE_API_KEY_UPDATE_ZONE`
>
> Tool to edit a Cloudflare zone. Use when you need to update a single zone property at a time. Ensure only one of paused, type, or vanity\_name\_servers is provided per call.
>
> #### Input Parameters
>
> **type** `string ("full" | "partial" | "secondary")`
>
> Zone type: 'full' (Cloudflare DNS), 'partial' (CNAME setup), or 'secondary'
>
> **paused** `boolean`
>
> Toggle DNS-only mode; true to disable security and performance features
>
> **zone\_id** `string` *required*
>
> Identifier of the zone to update (max length 32)
>
> **vanity\_name\_servers** `array`
>
> Custom nameserver domains (Business and Enterprise plans only)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File to S3
>
> **Slug:** `CLOUDFLARE_API_KEY_UPLOAD_FILE_TO_S3`
>
> Upload UTF-8 encoded text content to temporary storage for staging files used by actions requiring FileUploadable.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> Raw content of the file as a string; encoded as UTF-8 when uploaded.
>
> **mimetype** `string`
>
> MIME type of the file.
>
> **file\_name** `string` *required*
>
> Filename (including extension) to store.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
